docs.rs failed to build client-ip-0.2.0
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Visit the last successful build:
client-ip-0.2.1
client-ip
Secure extraction of a client IP from http::HeaderMap. The code was initially extracted from the axum-client-ip crate for non-axum use.
If you're maintaining client IP extraction in other frameworks based on http, consider using this crate, so we can handle security-sensitive code in one place. Look at the axum-client-ip integration for reference.
Supported extractors
Open an issue if there's an uncovered header or send a PR straight away.
| Extractor | Header Used | Typical Proxy / Service |
|---|---|---|
[cf_connecting_ip] |
CF-Connecting-IP |
Cloudflare |
[cloudfront_viewer_address] |
CloudFront-Viewer-Address |
AWS CloudFront |
[fly_client_ip] |
Fly-Client-IP |
Fly.io |
[rightmost_forwarded] |
Forwarded |
Proxies supporting RFC 7239 (extracts rightmost for=) |
[rightmost_x_forwarded_for] |
X-Forwarded-For |
Nginx, Apache, HAProxy, CDNs, LBs |
[true_client_ip] |
True-Client-IP |
Cloudflare, Akamai |
[x_envoy_external_address] |
X-Envoy-External-Address |
Envoy |
[x_real_ip] |
X-Real-Ip |
Nginx |
Contributing
- please run .pre-commit.sh before sending a PR, it will check everything
License
This project is licensed under the MIT license.