feat(ssl-certificate): get ssl certificate support proxy
Summary
Support proxy when getting ssl certificate
Same as #864 PR, but based on next branches.
import asyncio
from crawl4ai import (
AsyncWebCrawler,
BrowserConfig,
CrawlerRunConfig,
CacheMode,
DefaultMarkdownGenerator,
CrawlResult,
)
from crawl4ai.async_configs import ProxyConfig
async def main():
browser_config = BrowserConfig(headless=True, verbose=True)
async with AsyncWebCrawler(config=browser_config) as crawler:
crawler_config = CrawlerRunConfig(
cache_mode=CacheMode.BYPASS,
magic=True,
fetch_ssl_certificate=True,
proxy_config=ProxyConfig(server="socks5://127.0.0.1:1088"),
markdown_generator=DefaultMarkdownGenerator(
# content_filter=PruningContentFilter(
# threshold=0.48, threshold_type="fixed", min_word_threshold=0
# )
),
)
result : CrawlResult = await crawler.arun(
url="https://www.google.com", config=crawler_config
)
print("ssl:", result.ssl_certificate)
print("markdown: ",result.markdown[:500])
if __name__ == "__main__":
asyncio.run(main())
In [1]: from crawl4ai.ssl_certificate import SSLCertificate
In [2]: from crawl4ai.async_configs import ProxyConfig
In [3]: SSLCertificate.from_url(url="https://www.google.com", proxy_config=ProxyConfi
...: g("socks5://127.0.0.1:1088"), verify_ssl=False)
Out[3]: (<crawl4ai.ssl_certificate.SSLCertificate at 0x7681425650a0>, None)
In [4]: cert, err = SSLCertificate.from_url(url="https://www.google.com", proxy_confi
...: g=ProxyConfig("socks5://127.0.0.1:1088"), verify_ssl=False)
In [5]: cert
Out[5]: <crawl4ai.ssl_certificate.SSLCertificate at 0x7681819005f0>
In [6]: cert.subject
Out[6]: {'CN': 'www.google.com'}
In [7]: cert.to_playwright_format()
Out[7]:
{'issuer': 'WR2',
'subject': 'www.google.com',
'valid_from': 1742440831,
'valid_until': 1749698430}
List of files changed and why
ssl_ceritficate.py
- Support proxy when getting ssl certificate
- Support export certificate to playwright format with
ssl_ceritificate.to_playwright_format() - Support
str(ssl_ceritificate)
proxy_config.py
- Support for conversion of URLs with embedded credentials to ProxyConfig. The user and password in the URL with embedded credentials overrides
self.usernameandself.password. - e.g.
ProxyConfig(server="http://user:pass@proxy-server:1080",username="", password="") --(normalize)--> ProxyConfig(server="http://proxy-server:1080",username="user", password="pass")
async_crawler_strategy.py
- Crawling will set the proxy according to the configuration.
How Has This Been Tested?
- In the environment of network limitation, use http, https and socks5 proxy to test the website which is banned by firewall(like GFW), all of them can get SSL certificate(e.g. you can't access google directly in China, you need external proxy).
- In the environment where there is no network restriction, you can also get the certificate without using proxy.
Checklist:
- [x] My code follows the style guidelines of this project
- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] I have added/updated unit tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
here is test script ssl-proxy-test.md
Fixes: #778 - Tagging for visibility
[!IMPORTANT]
Review skipped
Auto reviews are disabled on base/target branches other than the default branch.
Please check the settings in the CodeRabbit UI or the
.coderabbit.yamlfile in this repository. To trigger a single review, invoke the@coderabbitai reviewcommand.You can disable this status message by setting the
reviews.review_statustofalsein the CodeRabbit configuration file.
🪧 Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
I pushed a fix in commit <commit_id>, please review it.Generate unit testing code for this file.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai generate unit testing code for this file.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.@coderabbitai read src/utils.ts and generate unit testing code.@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.@coderabbitai help me debug CodeRabbit configuration file.
Support
Need help? Create a ticket on our support page for assistance with any issues or questions.
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.
CodeRabbit Commands (Invoked using PR comments)
@coderabbitai pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR.@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile to the root of your repository. - Please see the configuration documentation for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation:
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.
@aravindkarnam When can we get it to merge? I think I'm ready.
this is fixed in the latest version, 0.7.6