diff --git a/docs/source/guide/advanced.md b/docs/source/guide/advanced.md index a7bb3987..8a5a2325 100644 --- a/docs/source/guide/advanced.md +++ b/docs/source/guide/advanced.md @@ -98,7 +98,7 @@ from wreq.tls import KeyLog async def main(): - client = Client(keylog=KeyLog.file("keylog.log")) + client = Client(tls_keylog=KeyLog.file("keylog.log")) resp = await client.get("https://www.google.com") async with resp: print(await resp.text()) diff --git a/docs/source/guide/websocket.md b/docs/source/guide/websocket.md index 264fd092..9bfa6205 100644 --- a/docs/source/guide/websocket.md +++ b/docs/source/guide/websocket.md @@ -96,7 +96,7 @@ async def recv_message(ws): async def main(): # Connect to HTTP/2 WebSocket server with force_http2=True - client = wreq.Client(verify=False) + client = wreq.Client(tls_verify=False) ws: WebSocket = await client.websocket( "wss://127.0.0.1:3000/ws", force_http2=True diff --git a/examples/http2_websocket.py b/examples/http2_websocket.py index 788e0330..a7072fcc 100644 --- a/examples/http2_websocket.py +++ b/examples/http2_websocket.py @@ -44,7 +44,7 @@ async def recv_message(ws): async def main(): - client = wreq.Client(verify=False) + client = wreq.Client(tls_verify=False) ws: WebSocket = await client.websocket("wss://127.0.0.1:3000/ws", force_http2=True) async with ws: print("Status Code: ", ws.status) diff --git a/examples/keylog.py b/examples/keylog.py index 51cf44c1..3366c276 100644 --- a/examples/keylog.py +++ b/examples/keylog.py @@ -4,7 +4,7 @@ async def main(): - client = Client(keylog=KeyLog.file("keylog.log")) + client = Client(tls_keylog=KeyLog.file("keylog.log")) resp = await client.get("https://www.google.com") async with resp: print(await resp.text()) diff --git a/python/wreq/wreq.py b/python/wreq/wreq.py index 2be42022..879d9452 100644 --- a/python/wreq/wreq.py +++ b/python/wreq/wreq.py @@ -675,22 +675,22 @@ class ClientConfig(TypedDict): # ======== TLS options ======== - verify: NotRequired[bool | Path | CertStore] + tls_verify: NotRequired[bool | Path | CertStore] """ Sets whether to verify TLS certificates. """ - verify_hostname: NotRequired[bool] + tls_verify_hostname: NotRequired[bool] """ Configures the use of hostname verification when connecting. """ - identity: NotRequired[Identity] + tls_identity: NotRequired[Identity] """ Represents a private key and X509 cert as a client certificate. """ - keylog: NotRequired[KeyLog] + tls_keylog: NotRequired[KeyLog] """ Key logging policy (environment or file). """ diff --git a/src/client.rs b/src/client.rs index e11d960a..72c08fa2 100644 --- a/src/client.rs +++ b/src/client.rs @@ -127,13 +127,13 @@ struct Builder { // ========= TLS options ========= /// Whether to verify the SSL certificate or root certificate file path. - verify: Option, + tls_verify: Option, /// Whether to verify the hostname in the SSL certificate. - verify_hostname: Option, + tls_verify_hostname: Option, /// Represents a private key and X509 cert as a client certificate. - identity: Option, + tls_identity: Option, /// Key logging policy for TLS session keys. - keylog: Option, + tls_keylog: Option, /// Add TLS information as `TlsInfo` extension to responses. tls_info: Option, /// The minimum TLS version to use for the client. @@ -211,10 +211,10 @@ impl FromPyObject<'_, '_> for Builder { extract_option!(ob, builder, http1_options); extract_option!(ob, builder, http2_options); - extract_option!(ob, builder, verify); - extract_option!(ob, builder, verify_hostname); - extract_option!(ob, builder, identity); - extract_option!(ob, builder, keylog); + extract_option!(ob, builder, tls_verify); + extract_option!(ob, builder, tls_verify_hostname); + extract_option!(ob, builder, tls_identity); + extract_option!(ob, builder, tls_keylog); extract_option!(ob, builder, tls_info); extract_option!(ob, builder, min_tls_version); extract_option!(ob, builder, max_tls_version); @@ -388,13 +388,13 @@ impl Client { apply_option!( set_if_some, builder, - config.verify_hostname, + config.tls_verify_hostname, verify_hostname ); - apply_option!(set_if_some_inner, builder, config.identity, identity); - apply_option!(set_if_some_inner, builder, config.keylog, keylog); + apply_option!(set_if_some_inner, builder, config.tls_identity, identity); + apply_option!(set_if_some_inner, builder, config.tls_keylog, keylog); apply_option!(set_if_some_inner, builder, config.tls_options, tls_options); - if let Some(verify) = config.verify.take() { + if let Some(verify) = config.tls_verify.take() { builder = match verify { TlsVerify::Verification(verify) => builder.cert_verification(verify), TlsVerify::CertificatePath(path_buf) => { diff --git a/tests/tls_test.py b/tests/tls_test.py index 2d9aa0c6..44e9225f 100644 --- a/tests/tls_test.py +++ b/tests/tls_test.py @@ -7,7 +7,7 @@ @pytest.mark.asyncio @pytest.mark.flaky(reruns=3, reruns_delay=2) async def test_badssl(): - client = wreq.Client(verify=False) + client = wreq.Client(tls_verify=False) resp = await client.get("https://self-signed.badssl.com/") async with resp: assert resp.status.is_success() @@ -17,7 +17,7 @@ async def test_badssl(): @pytest.mark.flaky(reruns=3, reruns_delay=2) async def test_badssl_invalid_cert(): url = "https://self-signed.badssl.com/" - client = wreq.Client(verify=False, tls_info=True) + client = wreq.Client(tls_verify=False, tls_info=True) resp = await client.get(url) async with resp: assert resp.status.is_success() @@ -33,7 +33,7 @@ async def test_badssl_invalid_cert(): cert_store = CertStore(der_certs=[peer_der_cert]) assert cert_store is not None - client = wreq.Client(verify=cert_store) + client = wreq.Client(tls_verify=cert_store) resp = await client.get(url) async with resp: assert resp.status.is_success()