fix(utils): Streamline IP capturing on incoming requests#13272

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
mydea merged 2 commits into from
Aug 8, 2024
Merged

fix(utils): Streamline IP capturing on incoming requests #13272

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
260f1a1
fix(utils): Streamline IP capturing on incoming requests
mydea Aug 7, 2024
5713885
fixes & tests
mydea Aug 8, 2024
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
17 changes: 0 additions & 17 deletions packages/remix/src/utils/web-fetch.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
/* eslint-disable complexity */
// Based on Remix's implementation of Fetch API
// https://github.com/remix-run/web-std-io/blob/d2a003fe92096aaf97ab2a618b74875ccaadc280/packages/fetch/
// The MIT License (MIT)
Expand All@@ -23,10 +22,6 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

import { logger } from '@sentry/utils';

import { DEBUG_BUILD } from './debug-build';
import { getClientIPAddress } from './vendor/getIpAddress';
import type { RemixRequest } from './vendor/types';

/*
Expand DownExpand Up@@ -124,15 +119,6 @@ export const normalizeRemixRequest = (request: RemixRequest): Record<string, any
headers.set('Connection', 'close');
}

let ip;

// Using a try block here not to break the whole request if we can't get the IP address
try {
ip = getClientIPAddress(headers);
} catch (e) {
DEBUG_BUILD && logger.warn('Could not get client IP address', e);
}

// HTTP-network fetch step 4.2
// chunked encoding is handled by Node.js
const search = getSearch(parsedURL);
Expand All@@ -156,9 +142,6 @@ export const normalizeRemixRequest = (request: RemixRequest): Record<string, any

// [SENTRY] For compatibility with Sentry SDK RequestData parser, adding `originalUrl` property.
originalUrl: parsedURL.href,

// [SENTRY] Adding `ip` property if found inside headers.
ip,
};

return requestOptions;
Expand Down
42 changes: 0 additions & 42 deletions packages/remix/test/utils/getIpAddress.test.ts
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion packages/remix/test/utils/normalizeRemixRequest.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -83,7 +83,6 @@ describe('normalizeRemixRequest', () => {
hostname: 'example.com',
href: 'https://example.com/api/json?id=123',
insecureHTTPParser: undefined,
ip: null,
method: 'GET',
originalUrl: 'https://example.com/api/json?id=123',
path: '/api/json?id=123',
Expand Down
34 changes: 22 additions & 12 deletions packages/utils/src/requestdata.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import { isPlainObject, isString } from './is';
import { logger } from './logger';
import { normalize } from './normalize';
import { stripUrlQueryAndFragment } from './url';
import { getClientIPAddress, ipHeaderNames } from './vendor/getIpAddress';

const DEFAULT_INCLUDES = {
ip: false,
Expand DownExpand Up@@ -98,7 +99,6 @@ export function extractPathForTransaction(
return [name, source];
}

/** JSDoc */
function extractTransaction(req: PolymorphicRequest, type: boolean | TransactionNamingScheme): string {
switch (type) {
case 'path': {
Expand All@@ -116,7 +116,6 @@ function extractTransaction(req: PolymorphicRequest, type: boolean | Transaction
}
}

/** JSDoc */
function extractUserData(
user: {
[key: string]: unknown;
Expand DownExpand Up@@ -146,17 +145,16 @@ function extractUserData(
*/
export function extractRequestData(
req: PolymorphicRequest,
options?: {
options: {
include?: string[];
},
} = {},
): ExtractedNodeRequestData {
const { include = DEFAULT_REQUEST_INCLUDES } = options || {};
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const requestData: { [key: string]: any } = {};
const { include = DEFAULT_REQUEST_INCLUDES } = options;
const requestData: { [key: string]: unknown } = {};

// headers:
// node, express, koa, nextjs: req.headers
const headers = (req.headers || {}) as {
const headers = (req.headers || {}) as typeof req.headers & {
host?: string;
cookie?: string;
};
Expand DownExpand Up@@ -191,6 +189,14 @@ export function extractRequestData(
delete (requestData.headers as { cookie?: string }).cookie;
}

// Remove IP headers in case IP data should not be included in the event
if (!include.includes('ip')) {
ipHeaderNames.forEach(ipHeaderName => {
// eslint-disable-next-line @typescript-eslint/no-dynamic-delete
delete (requestData.headers as Record<string, unknown>)[ipHeaderName];
});
}

break;
}
case 'method': {
Expand DownExpand Up@@ -264,9 +270,12 @@ export function addRequestDataToEvent(
};

if (include.request) {
const extractedRequestData = Array.isArray(include.request)
? extractRequestData(req, { include: include.request })
: extractRequestData(req);
const includeRequest = Array.isArray(include.request) ? [...include.request] : [...DEFAULT_REQUEST_INCLUDES];

@andreiborzaandreiborzaAug 8, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

q: do we need to spread include.request here?

@mydeamydeaAug 8, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, because we mutate this below possibly (adding the ip), and don't want to mutate what the user passes in! (ran into this in a test...)

if (include.ip) {
includeRequest.push('ip');
}

const extractedRequestData = extractRequestData(req, { include: includeRequest });

event.request = {
...event.request,
Expand All@@ -288,8 +297,9 @@ export function addRequestDataToEvent(
// client ip:
// node, nextjs: req.socket.remoteAddress
// express, koa: req.ip
// It may also be sent by proxies as specified in X-Forwarded-For or similar headers
if (include.ip) {
const ip = req.ip || (req.socket && req.socket.remoteAddress);
const ip = (req.headers && getClientIPAddress(req.headers)) || req.ip || (req.socket && req.socket.remoteAddress);
if (ip) {
event.user = {
...event.user,
Expand Down
82 changes: 49 additions & 33 deletions ...es/remix/src/utils/vendor/getIpAddress.ts → packages/utils/src/vendor/getIpAddress.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,58 +23,46 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

import { isIP } from 'net';
// The headers to check, in priority order
export const ipHeaderNames = [
'X-Client-IP',
'X-Forwarded-For',
'Fly-Client-IP',
'CF-Connecting-IP',
'Fastly-Client-Ip',
'True-Client-Ip',
'X-Real-IP',
'X-Cluster-Client-IP',
'X-Forwarded',
'Forwarded-For',
'Forwarded',
'X-Vercel-Forwarded-For',
];

/**
* Get the IP address of the client sending a request.
*
* It receives a Request headers object and use it to get the
* IP address from one of the following headers in order.
*
* - X-Client-IP
* - X-Forwarded-For
* - Fly-Client-IP
* - CF-Connecting-IP
* - Fastly-Client-Ip
* - True-Client-Ip
* - X-Real-IP
* - X-Cluster-Client-IP
* - X-Forwarded
* - Forwarded-For
* - Forwarded
*
* If the IP address is valid, it will be returned. Otherwise, null will be
* returned.
*
* If the header values contains more than one IP address, the first valid one
* will be returned.
*/
export function getClientIPAddress(headers: Headers): string | null {
// The headers to check, in priority order
const headerNames = [
'X-Client-IP',
'X-Forwarded-For',
'Fly-Client-IP',
'CF-Connecting-IP',
'Fastly-Client-Ip',
'True-Client-Ip',
'X-Real-IP',
'X-Cluster-Client-IP',
'X-Forwarded',
'Forwarded-For',
'Forwarded',
];

export function getClientIPAddress(headers: { [key: string]: string | string[] | undefined }): string | null {
// This will end up being Array<string | string[] | undefined | null> because of the various possible values a header
// can take
const headerValues = headerNames.map((headerName: string) => {
const value = headers.get(headerName);
const headerValues = ipHeaderNames.map((headerName: string) => {
const rawValue = headers[headerName];
const value = Array.isArray(rawValue) ? rawValue.join(';') : rawValue;

if (headerName === 'Forwarded') {
return parseForwardedHeader(value);
}

return value?.split(',').map((v: string) => v.trim());
return value && value.split(',').map((v: string) => v.trim());
});

// Flatten the array and filter out any falsy entries
Expand All@@ -92,7 +80,7 @@ export function getClientIPAddress(headers: Headers): string | null {
return ipAddress || null;
}

function parseForwardedHeader(value: string | null): string | null {
function parseForwardedHeader(value: string | null | undefined): string | null {
if (!value) {
return null;
}
Expand All@@ -105,3 +93,31 @@ function parseForwardedHeader(value: string | null): string | null {

return null;
}

//
/**
* Custom method instead of importing this from `net` package, as this only exists in node
* Accepts:
* 127.0.0.1
* 192.168.1.1
* 192.168.1.255
* 255.255.255.255
* 10.1.1.1
* 0.0.0.0
* 2b01:cb19:8350:ed00:d0dd:fa5b:de31:8be5
*
* Rejects:
* 1.1.1.01
* 30.168.1.255.1
* 127.1
* 192.168.1.256
* -1.2.3.4
* 1.1.1.1.
* 3...3
* 192.168.1.099
*/
function isIP(str: string): boolean {
const regex =
/(?:^(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}$)|(?:^(?:(?:[a-fA-F\d]{1,4}:){7}(?:[a-fA-F\d]{1,4}|:)|(?:[a-fA-F\d]{1,4}:){6}(?:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|:[a-fA-F\d]{1,4}|:)|(?:[a-fA-F\d]{1,4}:){5}(?::(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,2}|:)|(?:[a-fA-F\d]{1,4}:){4}(?:(?::[a-fA-F\d]{1,4}){0,1}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,3}|:)|(?:[a-fA-F\d]{1,4}:){3}(?:(?::[a-fA-F\d]{1,4}){0,2}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,4}|:)|(?:[a-fA-F\d]{1,4}:){2}(?:(?::[a-fA-F\d]{1,4}){0,3}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,5}|:)|(?:[a-fA-F\d]{1,4}:){1}(?:(?::[a-fA-F\d]{1,4}){0,4}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,6}|:)|(?::(?:(?::[a-fA-F\d]{1,4}){0,5}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,7}|:)))(?:%[0-9a-zA-Z]{1,})?$)/;
return regex.test(str);
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
fix(utils): Streamline IP capturing on incoming requests#13272

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

mydea
merged 2 commits into

from

Aug 8, 2024
 Merged


fix(utils): Streamline IP capturing on incoming requests
#13272
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
260f1a1

fix(utils): Streamline IP capturing on incoming requests


mydea Aug 7, 2024
5713885

fixes & tests


mydea Aug 8, 2024

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


17 changes: 0 additions & 17 deletions
packages/remix/src/utils/web-fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
/* eslint-disable complexity */
// Based on Remix's implementation of Fetch API
// https://github.com/remix-run/web-std-io/blob/d2a003fe92096aaf97ab2a618b74875ccaadc280/packages/fetch/
// The MIT License (MIT)
Expand All@@ -23,10 +22,6 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

import { logger } from '@sentry/utils';

import { DEBUG_BUILD } from './debug-build';
import { getClientIPAddress } from './vendor/getIpAddress';
import type { RemixRequest } from './vendor/types';

/*
Expand DownExpand Up@@ -124,15 +119,6 @@ export const normalizeRemixRequest = (request: RemixRequest): Record<string, any
 headers.set('Connection', 'close');
 }

 let ip;

 // Using a try block here not to break the whole request if we can't get the IP address
 try {
 ip = getClientIPAddress(headers);
 } catch (e) {
 DEBUG_BUILD && logger.warn('Could not get client IP address', e);
 }

 // HTTP-network fetch step 4.2
 // chunked encoding is handled by Node.js
 const search = getSearch(parsedURL);
Expand All@@ -156,9 +142,6 @@ export const normalizeRemixRequest = (request: RemixRequest): Record<string, any

 // [SENTRY] For compatibility with Sentry SDK RequestData parser, adding `originalUrl` property.
 originalUrl: parsedURL.href,

 // [SENTRY] Adding `ip` property if found inside headers.
 ip,
 };

 return requestOptions;
Expand Down

42 changes: 0 additions & 42 deletions
packages/remix/test/utils/getIpAddress.test.ts

View file


Open in desktop


This file was deleted.


1 change: 0 additions & 1 deletion
packages/remix/test/utils/normalizeRemixRequest.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,7 +83,6 @@ describe('normalizeRemixRequest', () => {
 hostname: 'example.com',
 href: 'https://example.com/api/json?id=123',
 insecureHTTPParser: undefined,
 ip: null,
 method: 'GET',
 originalUrl: 'https://example.com/api/json?id=123',
 path: '/api/json?id=123',
Expand Down

34 changes: 22 additions & 12 deletions
packages/utils/src/requestdata.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import { isPlainObject, isString } from './is';
import { logger } from './logger';
import { normalize } from './normalize';
import { stripUrlQueryAndFragment } from './url';
import { getClientIPAddress, ipHeaderNames } from './vendor/getIpAddress';

const DEFAULT_INCLUDES = {
 ip: false,
Expand DownExpand Up@@ -98,7 +99,6 @@ export function extractPathForTransaction(
 return [name, source];
}

/** JSDoc */
function extractTransaction(req: PolymorphicRequest, type: boolean | TransactionNamingScheme): string {
 switch (type) {
 case 'path': {
Expand All@@ -116,7 +116,6 @@ function extractTransaction(req: PolymorphicRequest, type: boolean | Transaction
 }
}

/** JSDoc */
function extractUserData(
 user: {
 [key: string]: unknown;
Expand DownExpand Up@@ -146,17 +145,16 @@ function extractUserData(
 */
export function extractRequestData(
 req: PolymorphicRequest,
 options?: {
 options: {
 include?: string[];
 },
 } = {},
): ExtractedNodeRequestData {
 const { include = DEFAULT_REQUEST_INCLUDES } = options || {};
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const requestData: { [key: string]: any } = {};
 const { include = DEFAULT_REQUEST_INCLUDES } = options;
 const requestData: { [key: string]: unknown } = {};

 // headers:
 // node, express, koa, nextjs: req.headers
 const headers = (req.headers || {}) as {
 const headers = (req.headers || {}) as typeof req.headers & {
 host?: string;
 cookie?: string;
 };
Expand DownExpand Up@@ -191,6 +189,14 @@ export function extractRequestData(
 delete (requestData.headers as { cookie?: string }).cookie;
 }

 // Remove IP headers in case IP data should not be included in the event
 if (!include.includes('ip')) {
 ipHeaderNames.forEach(ipHeaderName => {
 // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
 delete (requestData.headers as Record<string, unknown>)[ipHeaderName];
 });
 }

 break;
 }
 case 'method': {
Expand DownExpand Up@@ -264,9 +270,12 @@ export function addRequestDataToEvent(
 };

 if (include.request) {
 const extractedRequestData = Array.isArray(include.request)
 ? extractRequestData(req, { include: include.request })
 : extractRequestData(req);
 const includeRequest = Array.isArray(include.request) ? [...include.request] : [...DEFAULT_REQUEST_INCLUDES];
@andreiborzaandreiborzaAug 8, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

q: do we need to spread include.request here?
@mydeamydeaAug 8, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, because we mutate this below possibly (adding the ip), and don't want to mutate what the user passes in! (ran into this in a test...)
 if (include.ip) {
 includeRequest.push('ip');
 }

 const extractedRequestData = extractRequestData(req, { include: includeRequest });

 event.request = {
 ...event.request,
Expand All@@ -288,8 +297,9 @@ export function addRequestDataToEvent(
 // client ip:
 // node, nextjs: req.socket.remoteAddress
 // express, koa: req.ip
 // It may also be sent by proxies as specified in X-Forwarded-For or similar headers
 if (include.ip) {
 const ip = req.ip || (req.socket && req.socket.remoteAddress);
 const ip = (req.headers && getClientIPAddress(req.headers)) || req.ip || (req.socket && req.socket.remoteAddress);
 if (ip) {
 event.user = {
 ...event.user,
Expand Down

82 changes: 49 additions & 33 deletions
...es/remix/src/utils/vendor/getIpAddress.ts → packages/utils/src/vendor/getIpAddress.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,58 +23,46 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

import { isIP } from 'net';
// The headers to check, in priority order
export const ipHeaderNames = [
 'X-Client-IP',
 'X-Forwarded-For',
 'Fly-Client-IP',
 'CF-Connecting-IP',
 'Fastly-Client-Ip',
 'True-Client-Ip',
 'X-Real-IP',
 'X-Cluster-Client-IP',
 'X-Forwarded',
 'Forwarded-For',
 'Forwarded',
 'X-Vercel-Forwarded-For',
];

/**
 * Get the IP address of the client sending a request.
 *
 * It receives a Request headers object and use it to get the
 * IP address from one of the following headers in order.
 *
 * - X-Client-IP
 * - X-Forwarded-For
 * - Fly-Client-IP
 * - CF-Connecting-IP
 * - Fastly-Client-Ip
 * - True-Client-Ip
 * - X-Real-IP
 * - X-Cluster-Client-IP
 * - X-Forwarded
 * - Forwarded-For
 * - Forwarded
 *
 * If the IP address is valid, it will be returned. Otherwise, null will be
 * returned.
 *
 * If the header values contains more than one IP address, the first valid one
 * will be returned.
 */
export function getClientIPAddress(headers: Headers): string | null {
 // The headers to check, in priority order
 const headerNames = [
 'X-Client-IP',
 'X-Forwarded-For',
 'Fly-Client-IP',
 'CF-Connecting-IP',
 'Fastly-Client-Ip',
 'True-Client-Ip',
 'X-Real-IP',
 'X-Cluster-Client-IP',
 'X-Forwarded',
 'Forwarded-For',
 'Forwarded',
 ];

export function getClientIPAddress(headers: { [key: string]: string | string[] | undefined }): string | null {
 // This will end up being Array<string | string[] | undefined | null> because of the various possible values a header
 // can take
 const headerValues = headerNames.map((headerName: string) => {
 const value = headers.get(headerName);
 const headerValues = ipHeaderNames.map((headerName: string) => {
 const rawValue = headers[headerName];
 const value = Array.isArray(rawValue) ? rawValue.join(';') : rawValue;

 if (headerName === 'Forwarded') {
 return parseForwardedHeader(value);
 }

 return value?.split(',').map((v: string) => v.trim());
 return value && value.split(',').map((v: string) => v.trim());
 });

 // Flatten the array and filter out any falsy entries
Expand All@@ -92,7 +80,7 @@ export function getClientIPAddress(headers: Headers): string | null {
 return ipAddress || null;
}

function parseForwardedHeader(value: string | null): string | null {
function parseForwardedHeader(value: string | null | undefined): string | null {
 if (!value) {
 return null;
 }
Expand All@@ -105,3 +93,31 @@ function parseForwardedHeader(value: string | null): string | null {

 return null;
}

//
/**
 * Custom method instead of importing this from `net` package, as this only exists in node
 * Accepts:
 * 127.0.0.1
 * 192.168.1.1
 * 192.168.1.255
 * 255.255.255.255
 * 10.1.1.1
 * 0.0.0.0
 * 2b01:cb19:8350:ed00:d0dd:fa5b:de31:8be5
 *
 * Rejects:
 * 1.1.1.01
 * 30.168.1.255.1
 * 127.1
 * 192.168.1.256
 * -1.2.3.4
 * 1.1.1.1.
 * 3...3
 * 192.168.1.099
 */
function isIP(str: string): boolean {
 const regex =
 /(?:^(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}$)|(?:^(?:(?:[a-fA-F\d]{1,4}:){7}(?:[a-fA-F\d]{1,4}|:)|(?:[a-fA-F\d]{1,4}:){6}(?:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|:[a-fA-F\d]{1,4}|:)|(?:[a-fA-F\d]{1,4}:){5}(?::(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,2}|:)|(?:[a-fA-F\d]{1,4}:){4}(?:(?::[a-fA-F\d]{1,4}){0,1}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,3}|:)|(?:[a-fA-F\d]{1,4}:){3}(?:(?::[a-fA-F\d]{1,4}){0,2}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,4}|:)|(?:[a-fA-F\d]{1,4}:){2}(?:(?::[a-fA-F\d]{1,4}){0,3}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,5}|:)|(?:[a-fA-F\d]{1,4}:){1}(?:(?::[a-fA-F\d]{1,4}){0,4}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,6}|:)|(?::(?:(?::[a-fA-F\d]{1,4}){0,5}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,7}|:)))(?:%[0-9a-zA-Z]{1,})?$)/;
 return regex.test(str);
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(utils): Streamline IP capturing on incoming requests#13272

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

mydea
merged 2 commits into

from

Aug 8, 2024
 Merged


fix(utils): Streamline IP capturing on incoming requests
#13272
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
260f1a1

fix(utils): Streamline IP capturing on incoming requests


mydea Aug 7, 2024
5713885

fixes & tests


mydea Aug 8, 2024

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


17 changes: 0 additions & 17 deletions
packages/remix/src/utils/web-fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
/* eslint-disable complexity */
// Based on Remix's implementation of Fetch API
// https://github.com/remix-run/web-std-io/blob/d2a003fe92096aaf97ab2a618b74875ccaadc280/packages/fetch/
// The MIT License (MIT)
Expand All@@ -23,10 +22,6 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

import { logger } from '@sentry/utils';

import { DEBUG_BUILD } from './debug-build';
import { getClientIPAddress } from './vendor/getIpAddress';
import type { RemixRequest } from './vendor/types';

/*
Expand DownExpand Up@@ -124,15 +119,6 @@ export const normalizeRemixRequest = (request: RemixRequest): Record<string, any
 headers.set('Connection', 'close');
 }

 let ip;

 // Using a try block here not to break the whole request if we can't get the IP address
 try {
 ip = getClientIPAddress(headers);
 } catch (e) {
 DEBUG_BUILD && logger.warn('Could not get client IP address', e);
 }

 // HTTP-network fetch step 4.2
 // chunked encoding is handled by Node.js
 const search = getSearch(parsedURL);
Expand All@@ -156,9 +142,6 @@ export const normalizeRemixRequest = (request: RemixRequest): Record<string, any

 // [SENTRY] For compatibility with Sentry SDK RequestData parser, adding `originalUrl` property.
 originalUrl: parsedURL.href,

 // [SENTRY] Adding `ip` property if found inside headers.
 ip,
 };

 return requestOptions;
Expand Down

42 changes: 0 additions & 42 deletions
packages/remix/test/utils/getIpAddress.test.ts

View file


Open in desktop


This file was deleted.


1 change: 0 additions & 1 deletion
packages/remix/test/utils/normalizeRemixRequest.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,7 +83,6 @@ describe('normalizeRemixRequest', () => {
 hostname: 'example.com',
 href: 'https://example.com/api/json?id=123',
 insecureHTTPParser: undefined,
 ip: null,
 method: 'GET',
 originalUrl: 'https://example.com/api/json?id=123',
 path: '/api/json?id=123',
Expand Down

34 changes: 22 additions & 12 deletions
packages/utils/src/requestdata.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import { isPlainObject, isString } from './is';
import { logger } from './logger';
import { normalize } from './normalize';
import { stripUrlQueryAndFragment } from './url';
import { getClientIPAddress, ipHeaderNames } from './vendor/getIpAddress';

const DEFAULT_INCLUDES = {
 ip: false,
Expand DownExpand Up@@ -98,7 +99,6 @@ export function extractPathForTransaction(
 return [name, source];
}

/** JSDoc */
function extractTransaction(req: PolymorphicRequest, type: boolean | TransactionNamingScheme): string {
 switch (type) {
 case 'path': {
Expand All@@ -116,7 +116,6 @@ function extractTransaction(req: PolymorphicRequest, type: boolean | Transaction
 }
}

/** JSDoc */
function extractUserData(
 user: {
 [key: string]: unknown;
Expand DownExpand Up@@ -146,17 +145,16 @@ function extractUserData(
 */
export function extractRequestData(
 req: PolymorphicRequest,
 options?: {
 options: {
 include?: string[];
 },
 } = {},
): ExtractedNodeRequestData {
 const { include = DEFAULT_REQUEST_INCLUDES } = options || {};
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const requestData: { [key: string]: any } = {};
 const { include = DEFAULT_REQUEST_INCLUDES } = options;
 const requestData: { [key: string]: unknown } = {};

 // headers:
 // node, express, koa, nextjs: req.headers
 const headers = (req.headers || {}) as {
 const headers = (req.headers || {}) as typeof req.headers & {
 host?: string;
 cookie?: string;
 };
Expand DownExpand Up@@ -191,6 +189,14 @@ export function extractRequestData(
 delete (requestData.headers as { cookie?: string }).cookie;
 }

 // Remove IP headers in case IP data should not be included in the event
 if (!include.includes('ip')) {
 ipHeaderNames.forEach(ipHeaderName => {
 // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
 delete (requestData.headers as Record<string, unknown>)[ipHeaderName];
 });
 }

 break;
 }
 case 'method': {
Expand DownExpand Up@@ -264,9 +270,12 @@ export function addRequestDataToEvent(
 };

 if (include.request) {
 const extractedRequestData = Array.isArray(include.request)
 ? extractRequestData(req, { include: include.request })
 : extractRequestData(req);
 const includeRequest = Array.isArray(include.request) ? [...include.request] : [...DEFAULT_REQUEST_INCLUDES];
@andreiborzaandreiborzaAug 8, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

q: do we need to spread include.request here?
@mydeamydeaAug 8, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, because we mutate this below possibly (adding the ip), and don't want to mutate what the user passes in! (ran into this in a test...)
 if (include.ip) {
 includeRequest.push('ip');
 }

 const extractedRequestData = extractRequestData(req, { include: includeRequest });

 event.request = {
 ...event.request,
Expand All@@ -288,8 +297,9 @@ export function addRequestDataToEvent(
 // client ip:
 // node, nextjs: req.socket.remoteAddress
 // express, koa: req.ip
 // It may also be sent by proxies as specified in X-Forwarded-For or similar headers
 if (include.ip) {
 const ip = req.ip || (req.socket && req.socket.remoteAddress);
 const ip = (req.headers && getClientIPAddress(req.headers)) || req.ip || (req.socket && req.socket.remoteAddress);
 if (ip) {
 event.user = {
 ...event.user,
Expand Down

82 changes: 49 additions & 33 deletions
...es/remix/src/utils/vendor/getIpAddress.ts → packages/utils/src/vendor/getIpAddress.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,58 +23,46 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

import { isIP } from 'net';
// The headers to check, in priority order
export const ipHeaderNames = [
 'X-Client-IP',
 'X-Forwarded-For',
 'Fly-Client-IP',
 'CF-Connecting-IP',
 'Fastly-Client-Ip',
 'True-Client-Ip',
 'X-Real-IP',
 'X-Cluster-Client-IP',
 'X-Forwarded',
 'Forwarded-For',
 'Forwarded',
 'X-Vercel-Forwarded-For',
];

/**
 * Get the IP address of the client sending a request.
 *
 * It receives a Request headers object and use it to get the
 * IP address from one of the following headers in order.
 *
 * - X-Client-IP
 * - X-Forwarded-For
 * - Fly-Client-IP
 * - CF-Connecting-IP
 * - Fastly-Client-Ip
 * - True-Client-Ip
 * - X-Real-IP
 * - X-Cluster-Client-IP
 * - X-Forwarded
 * - Forwarded-For
 * - Forwarded
 *
 * If the IP address is valid, it will be returned. Otherwise, null will be
 * returned.
 *
 * If the header values contains more than one IP address, the first valid one
 * will be returned.
 */
export function getClientIPAddress(headers: Headers): string | null {
 // The headers to check, in priority order
 const headerNames = [
 'X-Client-IP',
 'X-Forwarded-For',
 'Fly-Client-IP',
 'CF-Connecting-IP',
 'Fastly-Client-Ip',
 'True-Client-Ip',
 'X-Real-IP',
 'X-Cluster-Client-IP',
 'X-Forwarded',
 'Forwarded-For',
 'Forwarded',
 ];

export function getClientIPAddress(headers: { [key: string]: string | string[] | undefined }): string | null {
 // This will end up being Array<string | string[] | undefined | null> because of the various possible values a header
 // can take
 const headerValues = headerNames.map((headerName: string) => {
 const value = headers.get(headerName);
 const headerValues = ipHeaderNames.map((headerName: string) => {
 const rawValue = headers[headerName];
 const value = Array.isArray(rawValue) ? rawValue.join(';') : rawValue;

 if (headerName === 'Forwarded') {
 return parseForwardedHeader(value);
 }

 return value?.split(',').map((v: string) => v.trim());
 return value && value.split(',').map((v: string) => v.trim());
 });

 // Flatten the array and filter out any falsy entries
Expand All@@ -92,7 +80,7 @@ export function getClientIPAddress(headers: Headers): string | null {
 return ipAddress || null;
}

function parseForwardedHeader(value: string | null): string | null {
function parseForwardedHeader(value: string | null | undefined): string | null {
 if (!value) {
 return null;
 }
Expand All@@ -105,3 +93,31 @@ function parseForwardedHeader(value: string | null): string | null {

 return null;
}

//
/**
 * Custom method instead of importing this from `net` package, as this only exists in node
 * Accepts:
 * 127.0.0.1
 * 192.168.1.1
 * 192.168.1.255
 * 255.255.255.255
 * 10.1.1.1
 * 0.0.0.0
 * 2b01:cb19:8350:ed00:d0dd:fa5b:de31:8be5
 *
 * Rejects:
 * 1.1.1.01
 * 30.168.1.255.1
 * 127.1
 * 192.168.1.256
 * -1.2.3.4
 * 1.1.1.1.
 * 3...3
 * 192.168.1.099
 */
function isIP(str: string): boolean {
 const regex =
 /(?:^(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}$)|(?:^(?:(?:[a-fA-F\d]{1,4}:){7}(?:[a-fA-F\d]{1,4}|:)|(?:[a-fA-F\d]{1,4}:){6}(?:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|:[a-fA-F\d]{1,4}|:)|(?:[a-fA-F\d]{1,4}:){5}(?::(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,2}|:)|(?:[a-fA-F\d]{1,4}:){4}(?:(?::[a-fA-F\d]{1,4}){0,1}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,3}|:)|(?:[a-fA-F\d]{1,4}:){3}(?:(?::[a-fA-F\d]{1,4}){0,2}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,4}|:)|(?:[a-fA-F\d]{1,4}:){2}(?:(?::[a-fA-F\d]{1,4}){0,3}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,5}|:)|(?:[a-fA-F\d]{1,4}:){1}(?:(?::[a-fA-F\d]{1,4}){0,4}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,6}|:)|(?::(?:(?::[a-fA-F\d]{1,4}){0,5}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,7}|:)))(?:%[0-9a-zA-Z]{1,})?$)/;
 return regex.test(str);
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(utils): Streamline IP capturing on incoming requests#13272

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

mydea
merged 2 commits into

from

Aug 8, 2024
 Merged


fix(utils): Streamline IP capturing on incoming requests
#13272
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
260f1a1

fix(utils): Streamline IP capturing on incoming requests


mydea Aug 7, 2024
5713885

fixes & tests


mydea Aug 8, 2024

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


17 changes: 0 additions & 17 deletions
packages/remix/src/utils/web-fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
/* eslint-disable complexity */
// Based on Remix's implementation of Fetch API
// https://github.com/remix-run/web-std-io/blob/d2a003fe92096aaf97ab2a618b74875ccaadc280/packages/fetch/
// The MIT License (MIT)
Expand All@@ -23,10 +22,6 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

import { logger } from '@sentry/utils';

import { DEBUG_BUILD } from './debug-build';
import { getClientIPAddress } from './vendor/getIpAddress';
import type { RemixRequest } from './vendor/types';

/*
Expand DownExpand Up@@ -124,15 +119,6 @@ export const normalizeRemixRequest = (request: RemixRequest): Record<string, any
 headers.set('Connection', 'close');
 }

 let ip;

 // Using a try block here not to break the whole request if we can't get the IP address
 try {
 ip = getClientIPAddress(headers);
 } catch (e) {
 DEBUG_BUILD && logger.warn('Could not get client IP address', e);
 }

 // HTTP-network fetch step 4.2
 // chunked encoding is handled by Node.js
 const search = getSearch(parsedURL);
Expand All@@ -156,9 +142,6 @@ export const normalizeRemixRequest = (request: RemixRequest): Record<string, any

 // [SENTRY] For compatibility with Sentry SDK RequestData parser, adding `originalUrl` property.
 originalUrl: parsedURL.href,

 // [SENTRY] Adding `ip` property if found inside headers.
 ip,
 };

 return requestOptions;
Expand Down

42 changes: 0 additions & 42 deletions
packages/remix/test/utils/getIpAddress.test.ts

View file


Open in desktop


This file was deleted.


1 change: 0 additions & 1 deletion
packages/remix/test/utils/normalizeRemixRequest.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,7 +83,6 @@ describe('normalizeRemixRequest', () => {
 hostname: 'example.com',
 href: 'https://example.com/api/json?id=123',
 insecureHTTPParser: undefined,
 ip: null,
 method: 'GET',
 originalUrl: 'https://example.com/api/json?id=123',
 path: '/api/json?id=123',
Expand Down

34 changes: 22 additions & 12 deletions
packages/utils/src/requestdata.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import { isPlainObject, isString } from './is';
import { logger } from './logger';
import { normalize } from './normalize';
import { stripUrlQueryAndFragment } from './url';
import { getClientIPAddress, ipHeaderNames } from './vendor/getIpAddress';

const DEFAULT_INCLUDES = {
 ip: false,
Expand DownExpand Up@@ -98,7 +99,6 @@ export function extractPathForTransaction(
 return [name, source];
}

/** JSDoc */
function extractTransaction(req: PolymorphicRequest, type: boolean | TransactionNamingScheme): string {
 switch (type) {
 case 'path': {
Expand All@@ -116,7 +116,6 @@ function extractTransaction(req: PolymorphicRequest, type: boolean | Transaction
 }
}

/** JSDoc */
function extractUserData(
 user: {
 [key: string]: unknown;
Expand DownExpand Up@@ -146,17 +145,16 @@ function extractUserData(
 */
export function extractRequestData(
 req: PolymorphicRequest,
 options?: {
 options: {
 include?: string[];
 },
 } = {},
): ExtractedNodeRequestData {
 const { include = DEFAULT_REQUEST_INCLUDES } = options || {};
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const requestData: { [key: string]: any } = {};
 const { include = DEFAULT_REQUEST_INCLUDES } = options;
 const requestData: { [key: string]: unknown } = {};

 // headers:
 // node, express, koa, nextjs: req.headers
 const headers = (req.headers || {}) as {
 const headers = (req.headers || {}) as typeof req.headers & {
 host?: string;
 cookie?: string;
 };
Expand DownExpand Up@@ -191,6 +189,14 @@ export function extractRequestData(
 delete (requestData.headers as { cookie?: string }).cookie;
 }

 // Remove IP headers in case IP data should not be included in the event
 if (!include.includes('ip')) {
 ipHeaderNames.forEach(ipHeaderName => {
 // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
 delete (requestData.headers as Record<string, unknown>)[ipHeaderName];
 });
 }

 break;
 }
 case 'method': {
Expand DownExpand Up@@ -264,9 +270,12 @@ export function addRequestDataToEvent(
 };

 if (include.request) {
 const extractedRequestData = Array.isArray(include.request)
 ? extractRequestData(req, { include: include.request })
 : extractRequestData(req);
 const includeRequest = Array.isArray(include.request) ? [...include.request] : [...DEFAULT_REQUEST_INCLUDES];
@andreiborzaandreiborzaAug 8, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

q: do we need to spread include.request here?
@mydeamydeaAug 8, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, because we mutate this below possibly (adding the ip), and don't want to mutate what the user passes in! (ran into this in a test...)
 if (include.ip) {
 includeRequest.push('ip');
 }

 const extractedRequestData = extractRequestData(req, { include: includeRequest });

 event.request = {
 ...event.request,
Expand All@@ -288,8 +297,9 @@ export function addRequestDataToEvent(
 // client ip:
 // node, nextjs: req.socket.remoteAddress
 // express, koa: req.ip
 // It may also be sent by proxies as specified in X-Forwarded-For or similar headers
 if (include.ip) {
 const ip = req.ip || (req.socket && req.socket.remoteAddress);
 const ip = (req.headers && getClientIPAddress(req.headers)) || req.ip || (req.socket && req.socket.remoteAddress);
 if (ip) {
 event.user = {
 ...event.user,
Expand Down

82 changes: 49 additions & 33 deletions
...es/remix/src/utils/vendor/getIpAddress.ts → packages/utils/src/vendor/getIpAddress.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,58 +23,46 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

import { isIP } from 'net';
// The headers to check, in priority order
export const ipHeaderNames = [
 'X-Client-IP',
 'X-Forwarded-For',
 'Fly-Client-IP',
 'CF-Connecting-IP',
 'Fastly-Client-Ip',
 'True-Client-Ip',
 'X-Real-IP',
 'X-Cluster-Client-IP',
 'X-Forwarded',
 'Forwarded-For',
 'Forwarded',
 'X-Vercel-Forwarded-For',
];

/**
 * Get the IP address of the client sending a request.
 *
 * It receives a Request headers object and use it to get the
 * IP address from one of the following headers in order.
 *
 * - X-Client-IP
 * - X-Forwarded-For
 * - Fly-Client-IP
 * - CF-Connecting-IP
 * - Fastly-Client-Ip
 * - True-Client-Ip
 * - X-Real-IP
 * - X-Cluster-Client-IP
 * - X-Forwarded
 * - Forwarded-For
 * - Forwarded
 *
 * If the IP address is valid, it will be returned. Otherwise, null will be
 * returned.
 *
 * If the header values contains more than one IP address, the first valid one
 * will be returned.
 */
export function getClientIPAddress(headers: Headers): string | null {
 // The headers to check, in priority order
 const headerNames = [
 'X-Client-IP',
 'X-Forwarded-For',
 'Fly-Client-IP',
 'CF-Connecting-IP',
 'Fastly-Client-Ip',
 'True-Client-Ip',
 'X-Real-IP',
 'X-Cluster-Client-IP',
 'X-Forwarded',
 'Forwarded-For',
 'Forwarded',
 ];

export function getClientIPAddress(headers: { [key: string]: string | string[] | undefined }): string | null {
 // This will end up being Array<string | string[] | undefined | null> because of the various possible values a header
 // can take
 const headerValues = headerNames.map((headerName: string) => {
 const value = headers.get(headerName);
 const headerValues = ipHeaderNames.map((headerName: string) => {
 const rawValue = headers[headerName];
 const value = Array.isArray(rawValue) ? rawValue.join(';') : rawValue;

 if (headerName === 'Forwarded') {
 return parseForwardedHeader(value);
 }

 return value?.split(',').map((v: string) => v.trim());
 return value && value.split(',').map((v: string) => v.trim());
 });

 // Flatten the array and filter out any falsy entries
Expand All@@ -92,7 +80,7 @@ export function getClientIPAddress(headers: Headers): string | null {
 return ipAddress || null;
}

function parseForwardedHeader(value: string | null): string | null {
function parseForwardedHeader(value: string | null | undefined): string | null {
 if (!value) {
 return null;
 }
Expand All@@ -105,3 +93,31 @@ function parseForwardedHeader(value: string | null): string | null {

 return null;
}

//
/**
 * Custom method instead of importing this from `net` package, as this only exists in node
 * Accepts:
 * 127.0.0.1
 * 192.168.1.1
 * 192.168.1.255
 * 255.255.255.255
 * 10.1.1.1
 * 0.0.0.0
 * 2b01:cb19:8350:ed00:d0dd:fa5b:de31:8be5
 *
 * Rejects:
 * 1.1.1.01
 * 30.168.1.255.1
 * 127.1
 * 192.168.1.256
 * -1.2.3.4
 * 1.1.1.1.
 * 3...3
 * 192.168.1.099
 */
function isIP(str: string): boolean {
 const regex =
 /(?:^(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}$)|(?:^(?:(?:[a-fA-F\d]{1,4}:){7}(?:[a-fA-F\d]{1,4}|:)|(?:[a-fA-F\d]{1,4}:){6}(?:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|:[a-fA-F\d]{1,4}|:)|(?:[a-fA-F\d]{1,4}:){5}(?::(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,2}|:)|(?:[a-fA-F\d]{1,4}:){4}(?:(?::[a-fA-F\d]{1,4}){0,1}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,3}|:)|(?:[a-fA-F\d]{1,4}:){3}(?:(?::[a-fA-F\d]{1,4}){0,2}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,4}|:)|(?:[a-fA-F\d]{1,4}:){2}(?:(?::[a-fA-F\d]{1,4}){0,3}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,5}|:)|(?:[a-fA-F\d]{1,4}:){1}(?:(?::[a-fA-F\d]{1,4}){0,4}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,6}|:)|(?::(?:(?::[a-fA-F\d]{1,4}){0,5}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,7}|:)))(?:%[0-9a-zA-Z]{1,})?$)/;
 return regex.test(str);
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
fix(utils): Streamline IP capturing on incoming requests#13272

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

mydea
merged 2 commits into

from

Aug 8, 2024
 Merged


fix(utils): Streamline IP capturing on incoming requests
#13272
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
260f1a1

fix(utils): Streamline IP capturing on incoming requests


mydea Aug 7, 2024
5713885

fixes & tests


mydea Aug 8, 2024

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


17 changes: 0 additions & 17 deletions
packages/remix/src/utils/web-fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
/* eslint-disable complexity */
// Based on Remix's implementation of Fetch API
// https://github.com/remix-run/web-std-io/blob/d2a003fe92096aaf97ab2a618b74875ccaadc280/packages/fetch/
// The MIT License (MIT)
Expand All@@ -23,10 +22,6 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

import { logger } from '@sentry/utils';

import { DEBUG_BUILD } from './debug-build';
import { getClientIPAddress } from './vendor/getIpAddress';
import type { RemixRequest } from './vendor/types';

/*
Expand DownExpand Up@@ -124,15 +119,6 @@ export const normalizeRemixRequest = (request: RemixRequest): Record<string, any
 headers.set('Connection', 'close');
 }

 let ip;

 // Using a try block here not to break the whole request if we can't get the IP address
 try {
 ip = getClientIPAddress(headers);
 } catch (e) {
 DEBUG_BUILD && logger.warn('Could not get client IP address', e);
 }

 // HTTP-network fetch step 4.2
 // chunked encoding is handled by Node.js
 const search = getSearch(parsedURL);
Expand All@@ -156,9 +142,6 @@ export const normalizeRemixRequest = (request: RemixRequest): Record<string, any

 // [SENTRY] For compatibility with Sentry SDK RequestData parser, adding `originalUrl` property.
 originalUrl: parsedURL.href,

 // [SENTRY] Adding `ip` property if found inside headers.
 ip,
 };

 return requestOptions;
Expand Down

42 changes: 0 additions & 42 deletions
packages/remix/test/utils/getIpAddress.test.ts

View file


Open in desktop


This file was deleted.


1 change: 0 additions & 1 deletion
packages/remix/test/utils/normalizeRemixRequest.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,7 +83,6 @@ describe('normalizeRemixRequest', () => {
 hostname: 'example.com',
 href: 'https://example.com/api/json?id=123',
 insecureHTTPParser: undefined,
 ip: null,
 method: 'GET',
 originalUrl: 'https://example.com/api/json?id=123',
 path: '/api/json?id=123',
Expand Down

34 changes: 22 additions & 12 deletions
packages/utils/src/requestdata.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import { isPlainObject, isString } from './is';
import { logger } from './logger';
import { normalize } from './normalize';
import { stripUrlQueryAndFragment } from './url';
import { getClientIPAddress, ipHeaderNames } from './vendor/getIpAddress';

const DEFAULT_INCLUDES = {
 ip: false,
Expand DownExpand Up@@ -98,7 +99,6 @@ export function extractPathForTransaction(
 return [name, source];
}

/** JSDoc */
function extractTransaction(req: PolymorphicRequest, type: boolean | TransactionNamingScheme): string {
 switch (type) {
 case 'path': {
Expand All@@ -116,7 +116,6 @@ function extractTransaction(req: PolymorphicRequest, type: boolean | Transaction
 }
}

/** JSDoc */
function extractUserData(
 user: {
 [key: string]: unknown;
Expand DownExpand Up@@ -146,17 +145,16 @@ function extractUserData(
 */
export function extractRequestData(
 req: PolymorphicRequest,
 options?: {
 options: {
 include?: string[];
 },
 } = {},
): ExtractedNodeRequestData {
 const { include = DEFAULT_REQUEST_INCLUDES } = options || {};
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const requestData: { [key: string]: any } = {};
 const { include = DEFAULT_REQUEST_INCLUDES } = options;
 const requestData: { [key: string]: unknown } = {};

 // headers:
 // node, express, koa, nextjs: req.headers
 const headers = (req.headers || {}) as {
 const headers = (req.headers || {}) as typeof req.headers & {
 host?: string;
 cookie?: string;
 };
Expand DownExpand Up@@ -191,6 +189,14 @@ export function extractRequestData(
 delete (requestData.headers as { cookie?: string }).cookie;
 }

 // Remove IP headers in case IP data should not be included in the event
 if (!include.includes('ip')) {
 ipHeaderNames.forEach(ipHeaderName => {
 // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
 delete (requestData.headers as Record<string, unknown>)[ipHeaderName];
 });
 }

 break;
 }
 case 'method': {
Expand DownExpand Up@@ -264,9 +270,12 @@ export function addRequestDataToEvent(
 };

 if (include.request) {
 const extractedRequestData = Array.isArray(include.request)
 ? extractRequestData(req, { include: include.request })
 : extractRequestData(req);
 const includeRequest = Array.isArray(include.request) ? [...include.request] : [...DEFAULT_REQUEST_INCLUDES];
@andreiborzaandreiborzaAug 8, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

q: do we need to spread include.request here?
@mydeamydeaAug 8, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, because we mutate this below possibly (adding the ip), and don't want to mutate what the user passes in! (ran into this in a test...)
 if (include.ip) {
 includeRequest.push('ip');
 }

 const extractedRequestData = extractRequestData(req, { include: includeRequest });

 event.request = {
 ...event.request,
Expand All@@ -288,8 +297,9 @@ export function addRequestDataToEvent(
 // client ip:
 // node, nextjs: req.socket.remoteAddress
 // express, koa: req.ip
 // It may also be sent by proxies as specified in X-Forwarded-For or similar headers
 if (include.ip) {
 const ip = req.ip || (req.socket && req.socket.remoteAddress);
 const ip = (req.headers && getClientIPAddress(req.headers)) || req.ip || (req.socket && req.socket.remoteAddress);
 if (ip) {
 event.user = {
 ...event.user,
Expand Down

82 changes: 49 additions & 33 deletions
...es/remix/src/utils/vendor/getIpAddress.ts → packages/utils/src/vendor/getIpAddress.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,58 +23,46 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

import { isIP } from 'net';
// The headers to check, in priority order
export const ipHeaderNames = [
 'X-Client-IP',
 'X-Forwarded-For',
 'Fly-Client-IP',
 'CF-Connecting-IP',
 'Fastly-Client-Ip',
 'True-Client-Ip',
 'X-Real-IP',
 'X-Cluster-Client-IP',
 'X-Forwarded',
 'Forwarded-For',
 'Forwarded',
 'X-Vercel-Forwarded-For',
];

/**
 * Get the IP address of the client sending a request.
 *
 * It receives a Request headers object and use it to get the
 * IP address from one of the following headers in order.
 *
 * - X-Client-IP
 * - X-Forwarded-For
 * - Fly-Client-IP
 * - CF-Connecting-IP
 * - Fastly-Client-Ip
 * - True-Client-Ip
 * - X-Real-IP
 * - X-Cluster-Client-IP
 * - X-Forwarded
 * - Forwarded-For
 * - Forwarded
 *
 * If the IP address is valid, it will be returned. Otherwise, null will be
 * returned.
 *
 * If the header values contains more than one IP address, the first valid one
 * will be returned.
 */
export function getClientIPAddress(headers: Headers): string | null {
 // The headers to check, in priority order
 const headerNames = [
 'X-Client-IP',
 'X-Forwarded-For',
 'Fly-Client-IP',
 'CF-Connecting-IP',
 'Fastly-Client-Ip',
 'True-Client-Ip',
 'X-Real-IP',
 'X-Cluster-Client-IP',
 'X-Forwarded',
 'Forwarded-For',
 'Forwarded',
 ];

export function getClientIPAddress(headers: { [key: string]: string | string[] | undefined }): string | null {
 // This will end up being Array<string | string[] | undefined | null> because of the various possible values a header
 // can take
 const headerValues = headerNames.map((headerName: string) => {
 const value = headers.get(headerName);
 const headerValues = ipHeaderNames.map((headerName: string) => {
 const rawValue = headers[headerName];
 const value = Array.isArray(rawValue) ? rawValue.join(';') : rawValue;

 if (headerName === 'Forwarded') {
 return parseForwardedHeader(value);
 }

 return value?.split(',').map((v: string) => v.trim());
 return value && value.split(',').map((v: string) => v.trim());
 });

 // Flatten the array and filter out any falsy entries
Expand All@@ -92,7 +80,7 @@ export function getClientIPAddress(headers: Headers): string | null {
 return ipAddress || null;
}

function parseForwardedHeader(value: string | null): string | null {
function parseForwardedHeader(value: string | null | undefined): string | null {
 if (!value) {
 return null;
 }
Expand All@@ -105,3 +93,31 @@ function parseForwardedHeader(value: string | null): string | null {

 return null;
}

//
/**
 * Custom method instead of importing this from `net` package, as this only exists in node
 * Accepts:
 * 127.0.0.1
 * 192.168.1.1
 * 192.168.1.255
 * 255.255.255.255
 * 10.1.1.1
 * 0.0.0.0
 * 2b01:cb19:8350:ed00:d0dd:fa5b:de31:8be5
 *
 * Rejects:
 * 1.1.1.01
 * 30.168.1.255.1
 * 127.1
 * 192.168.1.256
 * -1.2.3.4
 * 1.1.1.1.
 * 3...3
 * 192.168.1.099
 */
function isIP(str: string): boolean {
 const regex =
 /(?:^(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}$)|(?:^(?:(?:[a-fA-F\d]{1,4}:){7}(?:[a-fA-F\d]{1,4}|:)|(?:[a-fA-F\d]{1,4}:){6}(?:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|:[a-fA-F\d]{1,4}|:)|(?:[a-fA-F\d]{1,4}:){5}(?::(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,2}|:)|(?:[a-fA-F\d]{1,4}:){4}(?:(?::[a-fA-F\d]{1,4}){0,1}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,3}|:)|(?:[a-fA-F\d]{1,4}:){3}(?:(?::[a-fA-F\d]{1,4}){0,2}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,4}|:)|(?:[a-fA-F\d]{1,4}:){2}(?:(?::[a-fA-F\d]{1,4}){0,3}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,5}|:)|(?:[a-fA-F\d]{1,4}:){1}(?:(?::[a-fA-F\d]{1,4}){0,4}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,6}|:)|(?::(?:(?::[a-fA-F\d]{1,4}){0,5}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,7}|:)))(?:%[0-9a-zA-Z]{1,})?$)/;
 return regex.test(str);
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(utils): Streamline IP capturing on incoming requests#13272

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

mydea
merged 2 commits into

from

Aug 8, 2024
 Merged


fix(utils): Streamline IP capturing on incoming requests
#13272
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
260f1a1

fix(utils): Streamline IP capturing on incoming requests


mydea Aug 7, 2024
5713885

fixes & tests


mydea Aug 8, 2024

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


17 changes: 0 additions & 17 deletions
packages/remix/src/utils/web-fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
/* eslint-disable complexity */
// Based on Remix's implementation of Fetch API
// https://github.com/remix-run/web-std-io/blob/d2a003fe92096aaf97ab2a618b74875ccaadc280/packages/fetch/
// The MIT License (MIT)
Expand All@@ -23,10 +22,6 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

import { logger } from '@sentry/utils';

import { DEBUG_BUILD } from './debug-build';
import { getClientIPAddress } from './vendor/getIpAddress';
import type { RemixRequest } from './vendor/types';

/*
Expand DownExpand Up@@ -124,15 +119,6 @@ export const normalizeRemixRequest = (request: RemixRequest): Record<string, any
 headers.set('Connection', 'close');
 }

 let ip;

 // Using a try block here not to break the whole request if we can't get the IP address
 try {
 ip = getClientIPAddress(headers);
 } catch (e) {
 DEBUG_BUILD && logger.warn('Could not get client IP address', e);
 }

 // HTTP-network fetch step 4.2
 // chunked encoding is handled by Node.js
 const search = getSearch(parsedURL);
Expand All@@ -156,9 +142,6 @@ export const normalizeRemixRequest = (request: RemixRequest): Record<string, any

 // [SENTRY] For compatibility with Sentry SDK RequestData parser, adding `originalUrl` property.
 originalUrl: parsedURL.href,

 // [SENTRY] Adding `ip` property if found inside headers.
 ip,
 };

 return requestOptions;
Expand Down

42 changes: 0 additions & 42 deletions
packages/remix/test/utils/getIpAddress.test.ts

View file


Open in desktop


This file was deleted.


1 change: 0 additions & 1 deletion
packages/remix/test/utils/normalizeRemixRequest.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,7 +83,6 @@ describe('normalizeRemixRequest', () => {
 hostname: 'example.com',
 href: 'https://example.com/api/json?id=123',
 insecureHTTPParser: undefined,
 ip: null,
 method: 'GET',
 originalUrl: 'https://example.com/api/json?id=123',
 path: '/api/json?id=123',
Expand Down

34 changes: 22 additions & 12 deletions
packages/utils/src/requestdata.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import { isPlainObject, isString } from './is';
import { logger } from './logger';
import { normalize } from './normalize';
import { stripUrlQueryAndFragment } from './url';
import { getClientIPAddress, ipHeaderNames } from './vendor/getIpAddress';

const DEFAULT_INCLUDES = {
 ip: false,
Expand DownExpand Up@@ -98,7 +99,6 @@ export function extractPathForTransaction(
 return [name, source];
}

/** JSDoc */
function extractTransaction(req: PolymorphicRequest, type: boolean | TransactionNamingScheme): string {
 switch (type) {
 case 'path': {
Expand All@@ -116,7 +116,6 @@ function extractTransaction(req: PolymorphicRequest, type: boolean | Transaction
 }
}

/** JSDoc */
function extractUserData(
 user: {
 [key: string]: unknown;
Expand DownExpand Up@@ -146,17 +145,16 @@ function extractUserData(
 */
export function extractRequestData(
 req: PolymorphicRequest,
 options?: {
 options: {
 include?: string[];
 },
 } = {},
): ExtractedNodeRequestData {
 const { include = DEFAULT_REQUEST_INCLUDES } = options || {};
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const requestData: { [key: string]: any } = {};
 const { include = DEFAULT_REQUEST_INCLUDES } = options;
 const requestData: { [key: string]: unknown } = {};

 // headers:
 // node, express, koa, nextjs: req.headers
 const headers = (req.headers || {}) as {
 const headers = (req.headers || {}) as typeof req.headers & {
 host?: string;
 cookie?: string;
 };
Expand DownExpand Up@@ -191,6 +189,14 @@ export function extractRequestData(
 delete (requestData.headers as { cookie?: string }).cookie;
 }

 // Remove IP headers in case IP data should not be included in the event
 if (!include.includes('ip')) {
 ipHeaderNames.forEach(ipHeaderName => {
 // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
 delete (requestData.headers as Record<string, unknown>)[ipHeaderName];
 });
 }

 break;
 }
 case 'method': {
Expand DownExpand Up@@ -264,9 +270,12 @@ export function addRequestDataToEvent(
 };

 if (include.request) {
 const extractedRequestData = Array.isArray(include.request)
 ? extractRequestData(req, { include: include.request })
 : extractRequestData(req);
 const includeRequest = Array.isArray(include.request) ? [...include.request] : [...DEFAULT_REQUEST_INCLUDES];
@andreiborzaandreiborzaAug 8, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

q: do we need to spread include.request here?
@mydeamydeaAug 8, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, because we mutate this below possibly (adding the ip), and don't want to mutate what the user passes in! (ran into this in a test...)
 if (include.ip) {
 includeRequest.push('ip');
 }

 const extractedRequestData = extractRequestData(req, { include: includeRequest });

 event.request = {
 ...event.request,
Expand All@@ -288,8 +297,9 @@ export function addRequestDataToEvent(
 // client ip:
 // node, nextjs: req.socket.remoteAddress
 // express, koa: req.ip
 // It may also be sent by proxies as specified in X-Forwarded-For or similar headers
 if (include.ip) {
 const ip = req.ip || (req.socket && req.socket.remoteAddress);
 const ip = (req.headers && getClientIPAddress(req.headers)) || req.ip || (req.socket && req.socket.remoteAddress);
 if (ip) {
 event.user = {
 ...event.user,
Expand Down

82 changes: 49 additions & 33 deletions
...es/remix/src/utils/vendor/getIpAddress.ts → packages/utils/src/vendor/getIpAddress.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,58 +23,46 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

import { isIP } from 'net';
// The headers to check, in priority order
export const ipHeaderNames = [
 'X-Client-IP',
 'X-Forwarded-For',
 'Fly-Client-IP',
 'CF-Connecting-IP',
 'Fastly-Client-Ip',
 'True-Client-Ip',
 'X-Real-IP',
 'X-Cluster-Client-IP',
 'X-Forwarded',
 'Forwarded-For',
 'Forwarded',
 'X-Vercel-Forwarded-For',
];

/**
 * Get the IP address of the client sending a request.
 *
 * It receives a Request headers object and use it to get the
 * IP address from one of the following headers in order.
 *
 * - X-Client-IP
 * - X-Forwarded-For
 * - Fly-Client-IP
 * - CF-Connecting-IP
 * - Fastly-Client-Ip
 * - True-Client-Ip
 * - X-Real-IP
 * - X-Cluster-Client-IP
 * - X-Forwarded
 * - Forwarded-For
 * - Forwarded
 *
 * If the IP address is valid, it will be returned. Otherwise, null will be
 * returned.
 *
 * If the header values contains more than one IP address, the first valid one
 * will be returned.
 */
export function getClientIPAddress(headers: Headers): string | null {
 // The headers to check, in priority order
 const headerNames = [
 'X-Client-IP',
 'X-Forwarded-For',
 'Fly-Client-IP',
 'CF-Connecting-IP',
 'Fastly-Client-Ip',
 'True-Client-Ip',
 'X-Real-IP',
 'X-Cluster-Client-IP',
 'X-Forwarded',
 'Forwarded-For',
 'Forwarded',
 ];

export function getClientIPAddress(headers: { [key: string]: string | string[] | undefined }): string | null {
 // This will end up being Array<string | string[] | undefined | null> because of the various possible values a header
 // can take
 const headerValues = headerNames.map((headerName: string) => {
 const value = headers.get(headerName);
 const headerValues = ipHeaderNames.map((headerName: string) => {
 const rawValue = headers[headerName];
 const value = Array.isArray(rawValue) ? rawValue.join(';') : rawValue;

 if (headerName === 'Forwarded') {
 return parseForwardedHeader(value);
 }

 return value?.split(',').map((v: string) => v.trim());
 return value && value.split(',').map((v: string) => v.trim());
 });

 // Flatten the array and filter out any falsy entries
Expand All@@ -92,7 +80,7 @@ export function getClientIPAddress(headers: Headers): string | null {
 return ipAddress || null;
}

function parseForwardedHeader(value: string | null): string | null {
function parseForwardedHeader(value: string | null | undefined): string | null {
 if (!value) {
 return null;
 }
Expand All@@ -105,3 +93,31 @@ function parseForwardedHeader(value: string | null): string | null {

 return null;
}

//
/**
 * Custom method instead of importing this from `net` package, as this only exists in node
 * Accepts:
 * 127.0.0.1
 * 192.168.1.1
 * 192.168.1.255
 * 255.255.255.255
 * 10.1.1.1
 * 0.0.0.0
 * 2b01:cb19:8350:ed00:d0dd:fa5b:de31:8be5
 *
 * Rejects:
 * 1.1.1.01
 * 30.168.1.255.1
 * 127.1
 * 192.168.1.256
 * -1.2.3.4
 * 1.1.1.1.
 * 3...3
 * 192.168.1.099
 */
function isIP(str: string): boolean {
 const regex =
 /(?:^(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}$)|(?:^(?:(?:[a-fA-F\d]{1,4}:){7}(?:[a-fA-F\d]{1,4}|:)|(?:[a-fA-F\d]{1,4}:){6}(?:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|:[a-fA-F\d]{1,4}|:)|(?:[a-fA-F\d]{1,4}:){5}(?::(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,2}|:)|(?:[a-fA-F\d]{1,4}:){4}(?:(?::[a-fA-F\d]{1,4}){0,1}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,3}|:)|(?:[a-fA-F\d]{1,4}:){3}(?:(?::[a-fA-F\d]{1,4}){0,2}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,4}|:)|(?:[a-fA-F\d]{1,4}:){2}(?:(?::[a-fA-F\d]{1,4}){0,3}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,5}|:)|(?:[a-fA-F\d]{1,4}:){1}(?:(?::[a-fA-F\d]{1,4}){0,4}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,6}|:)|(?::(?:(?::[a-fA-F\d]{1,4}){0,5}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,7}|:)))(?:%[0-9a-zA-Z]{1,})?$)/;
 return regex.test(str);
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(utils): Streamline IP capturing on incoming requests#13272

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

mydea
merged 2 commits into

from

Aug 8, 2024
 Merged


fix(utils): Streamline IP capturing on incoming requests
#13272
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
260f1a1

fix(utils): Streamline IP capturing on incoming requests


mydea Aug 7, 2024
5713885

fixes & tests


mydea Aug 8, 2024

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


17 changes: 0 additions & 17 deletions
packages/remix/src/utils/web-fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
/* eslint-disable complexity */
// Based on Remix's implementation of Fetch API
// https://github.com/remix-run/web-std-io/blob/d2a003fe92096aaf97ab2a618b74875ccaadc280/packages/fetch/
// The MIT License (MIT)
Expand All@@ -23,10 +22,6 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

import { logger } from '@sentry/utils';

import { DEBUG_BUILD } from './debug-build';
import { getClientIPAddress } from './vendor/getIpAddress';
import type { RemixRequest } from './vendor/types';

/*
Expand DownExpand Up@@ -124,15 +119,6 @@ export const normalizeRemixRequest = (request: RemixRequest): Record<string, any
 headers.set('Connection', 'close');
 }

 let ip;

 // Using a try block here not to break the whole request if we can't get the IP address
 try {
 ip = getClientIPAddress(headers);
 } catch (e) {
 DEBUG_BUILD && logger.warn('Could not get client IP address', e);
 }

 // HTTP-network fetch step 4.2
 // chunked encoding is handled by Node.js
 const search = getSearch(parsedURL);
Expand All@@ -156,9 +142,6 @@ export const normalizeRemixRequest = (request: RemixRequest): Record<string, any

 // [SENTRY] For compatibility with Sentry SDK RequestData parser, adding `originalUrl` property.
 originalUrl: parsedURL.href,

 // [SENTRY] Adding `ip` property if found inside headers.
 ip,
 };

 return requestOptions;
Expand Down

42 changes: 0 additions & 42 deletions
packages/remix/test/utils/getIpAddress.test.ts

View file


Open in desktop


This file was deleted.


1 change: 0 additions & 1 deletion
packages/remix/test/utils/normalizeRemixRequest.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,7 +83,6 @@ describe('normalizeRemixRequest', () => {
 hostname: 'example.com',
 href: 'https://example.com/api/json?id=123',
 insecureHTTPParser: undefined,
 ip: null,
 method: 'GET',
 originalUrl: 'https://example.com/api/json?id=123',
 path: '/api/json?id=123',
Expand Down

34 changes: 22 additions & 12 deletions
packages/utils/src/requestdata.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import { isPlainObject, isString } from './is';
import { logger } from './logger';
import { normalize } from './normalize';
import { stripUrlQueryAndFragment } from './url';
import { getClientIPAddress, ipHeaderNames } from './vendor/getIpAddress';

const DEFAULT_INCLUDES = {
 ip: false,
Expand DownExpand Up@@ -98,7 +99,6 @@ export function extractPathForTransaction(
 return [name, source];
}

/** JSDoc */
function extractTransaction(req: PolymorphicRequest, type: boolean | TransactionNamingScheme): string {
 switch (type) {
 case 'path': {
Expand All@@ -116,7 +116,6 @@ function extractTransaction(req: PolymorphicRequest, type: boolean | Transaction
 }
}

/** JSDoc */
function extractUserData(
 user: {
 [key: string]: unknown;
Expand DownExpand Up@@ -146,17 +145,16 @@ function extractUserData(
 */
export function extractRequestData(
 req: PolymorphicRequest,
 options?: {
 options: {
 include?: string[];
 },
 } = {},
): ExtractedNodeRequestData {
 const { include = DEFAULT_REQUEST_INCLUDES } = options || {};
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const requestData: { [key: string]: any } = {};
 const { include = DEFAULT_REQUEST_INCLUDES } = options;
 const requestData: { [key: string]: unknown } = {};

 // headers:
 // node, express, koa, nextjs: req.headers
 const headers = (req.headers || {}) as {
 const headers = (req.headers || {}) as typeof req.headers & {
 host?: string;
 cookie?: string;
 };
Expand DownExpand Up@@ -191,6 +189,14 @@ export function extractRequestData(
 delete (requestData.headers as { cookie?: string }).cookie;
 }

 // Remove IP headers in case IP data should not be included in the event
 if (!include.includes('ip')) {
 ipHeaderNames.forEach(ipHeaderName => {
 // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
 delete (requestData.headers as Record<string, unknown>)[ipHeaderName];
 });
 }

 break;
 }
 case 'method': {
Expand DownExpand Up@@ -264,9 +270,12 @@ export function addRequestDataToEvent(
 };

 if (include.request) {
 const extractedRequestData = Array.isArray(include.request)
 ? extractRequestData(req, { include: include.request })
 : extractRequestData(req);
 const includeRequest = Array.isArray(include.request) ? [...include.request] : [...DEFAULT_REQUEST_INCLUDES];
@andreiborzaandreiborzaAug 8, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

q: do we need to spread include.request here?
@mydeamydeaAug 8, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, because we mutate this below possibly (adding the ip), and don't want to mutate what the user passes in! (ran into this in a test...)
 if (include.ip) {
 includeRequest.push('ip');
 }

 const extractedRequestData = extractRequestData(req, { include: includeRequest });

 event.request = {
 ...event.request,
Expand All@@ -288,8 +297,9 @@ export function addRequestDataToEvent(
 // client ip:
 // node, nextjs: req.socket.remoteAddress
 // express, koa: req.ip
 // It may also be sent by proxies as specified in X-Forwarded-For or similar headers
 if (include.ip) {
 const ip = req.ip || (req.socket && req.socket.remoteAddress);
 const ip = (req.headers && getClientIPAddress(req.headers)) || req.ip || (req.socket && req.socket.remoteAddress);
 if (ip) {
 event.user = {
 ...event.user,
Expand Down

82 changes: 49 additions & 33 deletions
...es/remix/src/utils/vendor/getIpAddress.ts → packages/utils/src/vendor/getIpAddress.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,58 +23,46 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

import { isIP } from 'net';
// The headers to check, in priority order
export const ipHeaderNames = [
 'X-Client-IP',
 'X-Forwarded-For',
 'Fly-Client-IP',
 'CF-Connecting-IP',
 'Fastly-Client-Ip',
 'True-Client-Ip',
 'X-Real-IP',
 'X-Cluster-Client-IP',
 'X-Forwarded',
 'Forwarded-For',
 'Forwarded',
 'X-Vercel-Forwarded-For',
];

/**
 * Get the IP address of the client sending a request.
 *
 * It receives a Request headers object and use it to get the
 * IP address from one of the following headers in order.
 *
 * - X-Client-IP
 * - X-Forwarded-For
 * - Fly-Client-IP
 * - CF-Connecting-IP
 * - Fastly-Client-Ip
 * - True-Client-Ip
 * - X-Real-IP
 * - X-Cluster-Client-IP
 * - X-Forwarded
 * - Forwarded-For
 * - Forwarded
 *
 * If the IP address is valid, it will be returned. Otherwise, null will be
 * returned.
 *
 * If the header values contains more than one IP address, the first valid one
 * will be returned.
 */
export function getClientIPAddress(headers: Headers): string | null {
 // The headers to check, in priority order
 const headerNames = [
 'X-Client-IP',
 'X-Forwarded-For',
 'Fly-Client-IP',
 'CF-Connecting-IP',
 'Fastly-Client-Ip',
 'True-Client-Ip',
 'X-Real-IP',
 'X-Cluster-Client-IP',
 'X-Forwarded',
 'Forwarded-For',
 'Forwarded',
 ];

export function getClientIPAddress(headers: { [key: string]: string | string[] | undefined }): string | null {
 // This will end up being Array<string | string[] | undefined | null> because of the various possible values a header
 // can take
 const headerValues = headerNames.map((headerName: string) => {
 const value = headers.get(headerName);
 const headerValues = ipHeaderNames.map((headerName: string) => {
 const rawValue = headers[headerName];
 const value = Array.isArray(rawValue) ? rawValue.join(';') : rawValue;

 if (headerName === 'Forwarded') {
 return parseForwardedHeader(value);
 }

 return value?.split(',').map((v: string) => v.trim());
 return value && value.split(',').map((v: string) => v.trim());
 });

 // Flatten the array and filter out any falsy entries
Expand All@@ -92,7 +80,7 @@ export function getClientIPAddress(headers: Headers): string | null {
 return ipAddress || null;
}

function parseForwardedHeader(value: string | null): string | null {
function parseForwardedHeader(value: string | null | undefined): string | null {
 if (!value) {
 return null;
 }
Expand All@@ -105,3 +93,31 @@ function parseForwardedHeader(value: string | null): string | null {

 return null;
}

//
/**
 * Custom method instead of importing this from `net` package, as this only exists in node
 * Accepts:
 * 127.0.0.1
 * 192.168.1.1
 * 192.168.1.255
 * 255.255.255.255
 * 10.1.1.1
 * 0.0.0.0
 * 2b01:cb19:8350:ed00:d0dd:fa5b:de31:8be5
 *
 * Rejects:
 * 1.1.1.01
 * 30.168.1.255.1
 * 127.1
 * 192.168.1.256
 * -1.2.3.4
 * 1.1.1.1.
 * 3...3
 * 192.168.1.099
 */
function isIP(str: string): boolean {
 const regex =
 /(?:^(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}$)|(?:^(?:(?:[a-fA-F\d]{1,4}:){7}(?:[a-fA-F\d]{1,4}|:)|(?:[a-fA-F\d]{1,4}:){6}(?:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|:[a-fA-F\d]{1,4}|:)|(?:[a-fA-F\d]{1,4}:){5}(?::(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,2}|:)|(?:[a-fA-F\d]{1,4}:){4}(?:(?::[a-fA-F\d]{1,4}){0,1}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,3}|:)|(?:[a-fA-F\d]{1,4}:){3}(?:(?::[a-fA-F\d]{1,4}){0,2}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,4}|:)|(?:[a-fA-F\d]{1,4}:){2}(?:(?::[a-fA-F\d]{1,4}){0,3}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,5}|:)|(?:[a-fA-F\d]{1,4}:){1}(?:(?::[a-fA-F\d]{1,4}){0,4}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,6}|:)|(?::(?:(?::[a-fA-F\d]{1,4}){0,5}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,7}|:)))(?:%[0-9a-zA-Z]{1,})?$)/;
 return regex.test(str);
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
fix(utils): Streamline IP capturing on incoming requests#13272

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

mydea
merged 2 commits into

from

Aug 8, 2024
 Merged


fix(utils): Streamline IP capturing on incoming requests
#13272
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
260f1a1

fix(utils): Streamline IP capturing on incoming requests


mydea Aug 7, 2024
5713885

fixes & tests


mydea Aug 8, 2024

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


17 changes: 0 additions & 17 deletions
packages/remix/src/utils/web-fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
/* eslint-disable complexity */
// Based on Remix's implementation of Fetch API
// https://github.com/remix-run/web-std-io/blob/d2a003fe92096aaf97ab2a618b74875ccaadc280/packages/fetch/
// The MIT License (MIT)
Expand All@@ -23,10 +22,6 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

import { logger } from '@sentry/utils';

import { DEBUG_BUILD } from './debug-build';
import { getClientIPAddress } from './vendor/getIpAddress';
import type { RemixRequest } from './vendor/types';

/*
Expand DownExpand Up@@ -124,15 +119,6 @@ export const normalizeRemixRequest = (request: RemixRequest): Record<string, any
 headers.set('Connection', 'close');
 }

 let ip;

 // Using a try block here not to break the whole request if we can't get the IP address
 try {
 ip = getClientIPAddress(headers);
 } catch (e) {
 DEBUG_BUILD && logger.warn('Could not get client IP address', e);
 }

 // HTTP-network fetch step 4.2
 // chunked encoding is handled by Node.js
 const search = getSearch(parsedURL);
Expand All@@ -156,9 +142,6 @@ export const normalizeRemixRequest = (request: RemixRequest): Record<string, any

 // [SENTRY] For compatibility with Sentry SDK RequestData parser, adding `originalUrl` property.
 originalUrl: parsedURL.href,

 // [SENTRY] Adding `ip` property if found inside headers.
 ip,
 };

 return requestOptions;
Expand Down

42 changes: 0 additions & 42 deletions
packages/remix/test/utils/getIpAddress.test.ts

View file


Open in desktop


This file was deleted.


1 change: 0 additions & 1 deletion
packages/remix/test/utils/normalizeRemixRequest.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,7 +83,6 @@ describe('normalizeRemixRequest', () => {
 hostname: 'example.com',
 href: 'https://example.com/api/json?id=123',
 insecureHTTPParser: undefined,
 ip: null,
 method: 'GET',
 originalUrl: 'https://example.com/api/json?id=123',
 path: '/api/json?id=123',
Expand Down

34 changes: 22 additions & 12 deletions
packages/utils/src/requestdata.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import { isPlainObject, isString } from './is';
import { logger } from './logger';
import { normalize } from './normalize';
import { stripUrlQueryAndFragment } from './url';
import { getClientIPAddress, ipHeaderNames } from './vendor/getIpAddress';

const DEFAULT_INCLUDES = {
 ip: false,
Expand DownExpand Up@@ -98,7 +99,6 @@ export function extractPathForTransaction(
 return [name, source];
}

/** JSDoc */
function extractTransaction(req: PolymorphicRequest, type: boolean | TransactionNamingScheme): string {
 switch (type) {
 case 'path': {
Expand All@@ -116,7 +116,6 @@ function extractTransaction(req: PolymorphicRequest, type: boolean | Transaction
 }
}

/** JSDoc */
function extractUserData(
 user: {
 [key: string]: unknown;
Expand DownExpand Up@@ -146,17 +145,16 @@ function extractUserData(
 */
export function extractRequestData(
 req: PolymorphicRequest,
 options?: {
 options: {
 include?: string[];
 },
 } = {},
): ExtractedNodeRequestData {
 const { include = DEFAULT_REQUEST_INCLUDES } = options || {};
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const requestData: { [key: string]: any } = {};
 const { include = DEFAULT_REQUEST_INCLUDES } = options;
 const requestData: { [key: string]: unknown } = {};

 // headers:
 // node, express, koa, nextjs: req.headers
 const headers = (req.headers || {}) as {
 const headers = (req.headers || {}) as typeof req.headers & {
 host?: string;
 cookie?: string;
 };
Expand DownExpand Up@@ -191,6 +189,14 @@ export function extractRequestData(
 delete (requestData.headers as { cookie?: string }).cookie;
 }

 // Remove IP headers in case IP data should not be included in the event
 if (!include.includes('ip')) {
 ipHeaderNames.forEach(ipHeaderName => {
 // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
 delete (requestData.headers as Record<string, unknown>)[ipHeaderName];
 });
 }

 break;
 }
 case 'method': {
Expand DownExpand Up@@ -264,9 +270,12 @@ export function addRequestDataToEvent(
 };

 if (include.request) {
 const extractedRequestData = Array.isArray(include.request)
 ? extractRequestData(req, { include: include.request })
 : extractRequestData(req);
 const includeRequest = Array.isArray(include.request) ? [...include.request] : [...DEFAULT_REQUEST_INCLUDES];
@andreiborzaandreiborzaAug 8, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

q: do we need to spread include.request here?
@mydeamydeaAug 8, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, because we mutate this below possibly (adding the ip), and don't want to mutate what the user passes in! (ran into this in a test...)
 if (include.ip) {
 includeRequest.push('ip');
 }

 const extractedRequestData = extractRequestData(req, { include: includeRequest });

 event.request = {
 ...event.request,
Expand All@@ -288,8 +297,9 @@ export function addRequestDataToEvent(
 // client ip:
 // node, nextjs: req.socket.remoteAddress
 // express, koa: req.ip
 // It may also be sent by proxies as specified in X-Forwarded-For or similar headers
 if (include.ip) {
 const ip = req.ip || (req.socket && req.socket.remoteAddress);
 const ip = (req.headers && getClientIPAddress(req.headers)) || req.ip || (req.socket && req.socket.remoteAddress);
 if (ip) {
 event.user = {
 ...event.user,
Expand Down

82 changes: 49 additions & 33 deletions
...es/remix/src/utils/vendor/getIpAddress.ts → packages/utils/src/vendor/getIpAddress.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,58 +23,46 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

import { isIP } from 'net';
// The headers to check, in priority order
export const ipHeaderNames = [
 'X-Client-IP',
 'X-Forwarded-For',
 'Fly-Client-IP',
 'CF-Connecting-IP',
 'Fastly-Client-Ip',
 'True-Client-Ip',
 'X-Real-IP',
 'X-Cluster-Client-IP',
 'X-Forwarded',
 'Forwarded-For',
 'Forwarded',
 'X-Vercel-Forwarded-For',
];

/**
 * Get the IP address of the client sending a request.
 *
 * It receives a Request headers object and use it to get the
 * IP address from one of the following headers in order.
 *
 * - X-Client-IP
 * - X-Forwarded-For
 * - Fly-Client-IP
 * - CF-Connecting-IP
 * - Fastly-Client-Ip
 * - True-Client-Ip
 * - X-Real-IP
 * - X-Cluster-Client-IP
 * - X-Forwarded
 * - Forwarded-For
 * - Forwarded
 *
 * If the IP address is valid, it will be returned. Otherwise, null will be
 * returned.
 *
 * If the header values contains more than one IP address, the first valid one
 * will be returned.
 */
export function getClientIPAddress(headers: Headers): string | null {
 // The headers to check, in priority order
 const headerNames = [
 'X-Client-IP',
 'X-Forwarded-For',
 'Fly-Client-IP',
 'CF-Connecting-IP',
 'Fastly-Client-Ip',
 'True-Client-Ip',
 'X-Real-IP',
 'X-Cluster-Client-IP',
 'X-Forwarded',
 'Forwarded-For',
 'Forwarded',
 ];

export function getClientIPAddress(headers: { [key: string]: string | string[] | undefined }): string | null {
 // This will end up being Array<string | string[] | undefined | null> because of the various possible values a header
 // can take
 const headerValues = headerNames.map((headerName: string) => {
 const value = headers.get(headerName);
 const headerValues = ipHeaderNames.map((headerName: string) => {
 const rawValue = headers[headerName];
 const value = Array.isArray(rawValue) ? rawValue.join(';') : rawValue;

 if (headerName === 'Forwarded') {
 return parseForwardedHeader(value);
 }

 return value?.split(',').map((v: string) => v.trim());
 return value && value.split(',').map((v: string) => v.trim());
 });

 // Flatten the array and filter out any falsy entries
Expand All@@ -92,7 +80,7 @@ export function getClientIPAddress(headers: Headers): string | null {
 return ipAddress || null;
}

function parseForwardedHeader(value: string | null): string | null {
function parseForwardedHeader(value: string | null | undefined): string | null {
 if (!value) {
 return null;
 }
Expand All@@ -105,3 +93,31 @@ function parseForwardedHeader(value: string | null): string | null {

 return null;
}

//
/**
 * Custom method instead of importing this from `net` package, as this only exists in node
 * Accepts:
 * 127.0.0.1
 * 192.168.1.1
 * 192.168.1.255
 * 255.255.255.255
 * 10.1.1.1
 * 0.0.0.0
 * 2b01:cb19:8350:ed00:d0dd:fa5b:de31:8be5
 *
 * Rejects:
 * 1.1.1.01
 * 30.168.1.255.1
 * 127.1
 * 192.168.1.256
 * -1.2.3.4
 * 1.1.1.1.
 * 3...3
 * 192.168.1.099
 */
function isIP(str: string): boolean {
 const regex =
 /(?:^(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}$)|(?:^(?:(?:[a-fA-F\d]{1,4}:){7}(?:[a-fA-F\d]{1,4}|:)|(?:[a-fA-F\d]{1,4}:){6}(?:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|:[a-fA-F\d]{1,4}|:)|(?:[a-fA-F\d]{1,4}:){5}(?::(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,2}|:)|(?:[a-fA-F\d]{1,4}:){4}(?:(?::[a-fA-F\d]{1,4}){0,1}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,3}|:)|(?:[a-fA-F\d]{1,4}:){3}(?:(?::[a-fA-F\d]{1,4}){0,2}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,4}|:)|(?:[a-fA-F\d]{1,4}:){2}(?:(?::[a-fA-F\d]{1,4}){0,3}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,5}|:)|(?:[a-fA-F\d]{1,4}:){1}(?:(?::[a-fA-F\d]{1,4}){0,4}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,6}|:)|(?::(?:(?::[a-fA-F\d]{1,4}){0,5}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,7}|:)))(?:%[0-9a-zA-Z]{1,})?$)/;
 return regex.test(str);
}
Loading