Skip to content
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.

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

CherryPy/Cheroot SSL Built-in Adapter Causing Port Contention with Netcat #709

Open
1 of 3 tasks
PraveenKumarVN opened this issue May 9, 2024 · 3 comments
Open
1 of 3 tasks
Labels
bug Something is broken triage

Comments

@PraveenKumarVN
Copy link

I'm encountering an issue with CherryPy's built-in SSL adapter where it seems to cause port contention with netcat. When I run a CherryPy server with SSL enabled using the built-in adapter, and establish a TCP connection using netcat nc localhost 8080 without performing TLS handshake, not able to access the application via browser or any other client until I complete the TLS handshake in netcat. However, if I switch to using PyOpenSSL, able to access the application via other clients while TLS handshake is not yet done in TCP connection via netcat.

I'm not sure why the built-in SSL adapter is causing this behavior, but it seems to be related to how it manages SSL connections or handles socket bindings.

Has anyone encountered a similar issue with CherryPy's built-in SSL adapter? Any insights or suggestions on how to resolve or further debug this issue would be greatly appreciated.

Thank you!

I'm submitting a ...

  • 🐞 bug report
  • 🐣 feature request
  • ❓ question about the decisions made in the repository

🐞 Describe the bug. What is the current behavior?

Here's a summary of the setup and behavior:

  • I have a CherryPy application configured to use SSL with the built-in adapter.
  • When I start the CherryPy server, it binds to the specified port with SSL enabled.
  • Access the URL https://localhost:8080/ in browser, returns "Hello, world!"
  • Execute nc localhost 8080 in a terminal
  • Access the URL https://localhost:8080/ again in browser, it hangs.
  • Terminate ctrl+c the nc command in terminal, "Hello, world!" is returned in the browser.
  • But if change to cherrypy.server.ssl_module = 'pyopenssl', with TCP connection established using nc, able to access the URL in the browser and other clients.

Please provide the steps to reproduce and if possible a screenshots and logs of the problem. If you can, show us your code.

class YourApp:
    @cherrypy.expose
    def index(self):
        return "Hello, world!"


if __name__ == '__main__':
    # Configuration
    cherrypy.config.update({
        'server.thread_pool': 10,  # Number of threads in the pool
        'server.socket_host': '0.0.0.0',  # Bind to all interfaces
        'server.socket_port': 8080,  # Port to listen on
        'server.socket_timeout': 60
    })

    cherrypy.server.ssl_module = 'builtin'  # Use the built-in SSL module
    cherrypy.server.ssl_certificate = 'cert.pem'  # Path to your SSL certificate
    cherrypy.server.ssl_private_key = 'key.pem'

    cherrypy.quickstart(YourApp(), '/')

💡 Expected behavior

App should server requests even if a connection handshake is in progress

📋 Details

📋 Environment

  • Cheroot version: 10.0.1
  • CherryPy version: 18.9.0
  • Python version: 3.11
  • OS: MacOs 14.1
  • Browser: all

📋 Additional context

@webknjaz
Copy link
Member

webknjaz commented May 9, 2024

Could you attach that Cheroot-only reproducer that I was asking for in #649 (comment)?

@PraveenKumarVN
Copy link
Author

PraveenKumarVN commented May 15, 2024

Hi @webknjaz Please find below the reproducer only using cheroot

    from cheroot.ssl.builtin import BuiltinSSLAdapter

    def my_crazy_app(environ, start_response):
        status = '200 OK'
        response_headers = [('Content-type', 'text/plain')]
        start_response(status, response_headers)
        return [b'Hello world!']

    addr = '0.0.0.0', 8070
    certfile = 'cert.pem'
    keyfile = 'key.pem'

    server = wsgi.Server(addr, my_crazy_app)
    server.ssl_adapter = BuiltinSSLAdapter(certfile, keyfile, None)
    server.start()

@PraveenKumarVN
Copy link
Author

@webknjaz Any update on this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something is broken triage
Projects
None yet
Development

No branches or pull requests

2 participants