NAX IP软件( 一个节点应用程序不可知库)

服务器应用程序的节点库, 检索用户真实的 IP 地址

概览

最佳尝试 在保留客户端IP地址的同时获取该地址 饮用。 。 。 .

通知

没有好东西 out-of-the-box 针对假IP地址的解决方案, aka IP 地址窃取。 。 。 . 欢迎您阅读 高级用户 本页各节 使用情况 trusted proxy prefixes 和(或) proxy count 符合您需要的特性,特别是 若为 你们是 计划纳入 ipware 在任何认证、安全或 anti-fraud 相关结构. 同时鼓励您使用 ip 过滤 ipware 以取得最佳结果.

如何安装

npm install @fullerstack/nax-ipware 或 yarn add @fullerstack/nax-ipware

如何使用

 # In a view or a middleware where the `request` object is available

  // In your js file (e.g. app.js)
  import {Ipware} from '@fullerstack/nax-ipware';
  const ipware = new Ipware();
  app.use(function(req, res, next) {
    req.ipInfo = ipware.getClientIP(req)
    // { ip: '177.139.100.100', isPublic: true, isRouteTrusted: false }
    // do something with the ip address (e.g. pass it down through the request)
    // note: ip address doesn't change often, so better cache it for performance,
    // you should have distinct session ID for public and anonymous users to cache the ip address
    next();
  });

高级用户 :

优先发言顺序

客户端IP地址可以在一个或多个请求头属性中找到. 查找顺序从上到下,默认属性作为后继.

// The default meta precedence order
export const IPWARE_HEADERS_IP_ATTRIBUTES_ORDER: string[] = [
  'X_FORWARDED_FOR', // Load balancers or proxies such as AWS ELB (default client is `left-most` [`<client>, <proxy1>, <proxy2>`])
  'HTTP_X_FORWARDED_FOR', // Similar to X_FORWARDED_TO
  'HTTP_CLIENT_IP', // Standard headers used by providers such as Amazon EC2, Heroku etc.
  'HTTP_X_REAL_IP',
  'HTTP_X_FORWARDED',
  'HTTP_X_CLUSTER_CLIENT_IP',
  'HTTP_FORWARDED_FOR',
  'HTTP_FORWARDED',
  'HTTP_VIA',
  'X-REAL-IP', // NGINX
  'X-CLUSTER-CLIENT-IP', // Rackspace Cloud Load Balancers
  'X_FORWARDED',
  'FORWARDED_FOR',
  'CF-CONNECTING-IP', // CloudFlare
  'TRUE-CLIENT-IP', // CloudFlare Enterprise,
  'FASTLY-CLIENT-IP', // Firebase, Fastly
  'FORWARDED',
];

您可以在初始化时提供自己的列表来自定义命令 new Ipware(options)。 。 。 . 您可以在每次呼叫时通过您的自定义列表, 以获取 ip .

  ipware.getClientIP(request, {
    requestHeadersOrder: ['X_FORWARDED_FOR'],
  });

  ipware.getClientIP(request, {
    requestHeadersOrder: ['X_FORWARDED_FOR', 'HTTP_X_FORWARDED_FOR'],
  });

  // ... etc

私人前缀

一个持有私有 IP 前缀的默认列表叫做 IPWARE_PRIVATE_IP_PREFIX。 。 。 . 此列表用于确定 IP 地址是否 public 或者说 private。 。 。 .

建议你给我们发任何 private 我们错过的IP地址, 将包含在默认列表中 .

export const IPWARE_PRIVATE_IP_PREFIX: string[] = [
  '0.', // messages to software
  '10.', // class A private block
  ...[
    // carrier-grade NAT (IPv4)
    '100.64.',
    '100.65.',
    '100.66.',
    '100.67.',
  ],
  // many more prefixes
]

您可以自定义私人 IP 前缀, 在初始化时提供自己的列表 new Ipware(options)。 。 。 . 您可以在每次呼叫时通过您的自定义列表, 以获取 ip .

  ipware.getClientIP(request, {
    privateIpPrefixes: ['0.', '10.'], // your own private IP addresses
  });

  ipware.getClientIP(request, {
    privateIpPrefixes: ['0.', '10.', '2001:10:'], // your own private IP addresses
  });

  // ... etc

信任的代理人

如果您的节点服务器位于一个或多个已知代理服务器后方, 您可以过滤不想要的请求 通过提供 trusted proxy list,或已知的代理服务器 count。 。 。 .

您可以自定义代理 IP 前缀, 在初始化时提供自己的列表 new Ipware(options)。 。 。 . 您可以在每次呼叫中通过您的自定义列表, 当呼叫代理意识 api 来获取 ip 时 .

// In the above scenario, use your load balancer IP address as a way to filter out unwanted requests.
const ipInfo = ipware.getClientIP(request, {
  proxy: {
    proxyList: ['177.139.233.132']
  },
});

// If you have multiple proxies, simply add them to the list
const ipInfo = ipware.getClientIP(request, {
  proxy: {
    proxyList: ['177.139.233.100', '177.139.233.132']
  },
});

// For proxy servers with fixed sub-domain and dynamic IP, use the following pattern.
const ipInfo = ipware.getClientIP(request, {
  proxy: {
    proxyList: ['177.139.', '177.140']
  },
});

const ipInfo = ipware.getClientIP(request, {
  proxy: {
    proxyList: ['177.139.233.', '177.139.240']
  },
});

// For proxy by ip address and count
const ipInfo = ipware.getClientIP(request, {
  proxy: {
    proxyList: ['177.139.', '177.140'],
    count: 2
  },
});

// For strict mode, we either return the ip that matches the proxy info, or none
const ipInfo = ipware.getClientIP(request, {
  proxy: {
    strict: true,
    proxyList: ['177.139.233.', '177.139.240']
  },
});

如下所述: example,您的公共负载平衡器(LB)可被视为一个 trusted 代理服务器.

`Real` Client <public> <-> <public> LB (Server) <private> <-----> <private> Node Server
                                                             ^
                                                             |
`Fake` Client <private> <-> <private> LB (Server) <private> -+

代理计算

如果您的节点服务器位于后面 known 代理服务器的数量,但您在多个供应商上的部署,并且不想跟踪代理IP,您仍然可以通过提供代理来过滤不想要的请求 count。 。 。 .

您可以自定义代理数 count 在初始化时打电话 new Ipware(options)。 。 。 . 你可以通过你的习惯 count 当调用代理意识的 api 来获取 ip.

// In the above scenario, the total number of proxies can be used as a way to filter out unwanted requests.
const ipInfo = ipware.getClientIP(request, {
  proxy: {
    count: 1
  },
});

// For proxy by count, and proxy list
const ipInfo = ipware.getClientIP(request, {
  proxy: {
    count: 1
    proxyList: ['177.139.233.']
  },
});

// For strict mode, we either return the ip that matches the proxy info, or none
const ipInfo = ipware.getClientIP(request, {
  proxy: {
    strict: true,
    count: 1
  },
});

如下所述: example,您的公共负载平衡器(LB)可被视为 only 代理服务器.

`Real` Client <public> <-> <public> LB (Server) <private> <---> <private> Node Server
                                                            ^
                                                            |
                                `Fake` Client  <private> ---+

只有公开的IP地址(互联网上的程序表)

// For publicOnly mode, we either return the first public IP address based on order or none
const ipInfo = ipware.getClientIP(request, {
  publicOnly: true
});

创建请求

如果您的代理服务器有 custom 配置 right-most IP 地址是源客户端的地址, 您 可以显示 right-most 作为 order 当唤作任何一物时. 请注意: 事实 标准 对于源客户端 IP 地址是 left-most 总计 client, proxy1, proxy2,则 right-most 代理最多 信任的代理服务器 .

运行测试

对照当前环境进行测试:

yarn nx test nax-ipware

许可证

A) 释放麻省理工学院许可证.

版本

X.Y.Z 版本

`MAJOR` version -- making incompatible API changes
`MINOR` version -- adding functionality in a backwards-compatible manner
`PATCH` version -- making backwards-compatible bug fixes

发起人

Neekware Inc. (英语).