文章/答案/技术大牛

发布

社区首页 >问答首页 >Python 3中的Websocket实现

问Python 3中的Websocket实现
EN

Stack Overflow用户

提问于 2012-10-14 04:21:21

回答 1查看 3.7K关注 0票数 7

试图为Python3支持的应用程序创建web前端。该应用程序将需要双向流，这听起来是一个研究websockets的好机会。

我的第一个倾向是使用已经存在的东西，来自的示例应用程序已经证明是有价值的。不幸的是，他们的API似乎并不容易扩展，而它就是Python2。

纵观博客圈，许多人已经为websocket协议的早期版本编写了自己的websocket服务器，大多数人都没有实现安全密钥哈希，因此无法工作。

阅读RFC 6455后，我决定亲自尝试一下，并得出如下结论：

#!/usr/bin/env python3

"""
A partial implementation of RFC 6455
http://tools.ietf.org/pdf/rfc6455.pdf
Brian Thorne 2012
"""
  
import socket
import threading
import time
import base64
import hashlib

def calculate_websocket_hash(key):
    magic_websocket_string = b"258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
    result_string = key + magic_websocket_string
    sha1_digest = hashlib.sha1(result_string).digest()
    response_data = base64.encodestring(sha1_digest)
    response_string = response_data.decode('utf8')
    return response_string

def is_bit_set(int_type, offset):
    mask = 1 << offset
    return not 0 == (int_type & mask)

def set_bit(int_type, offset):
    return int_type | (1 << offset)

def bytes_to_int(data):
    # note big-endian is the standard network byte order
    return int.from_bytes(data, byteorder='big')


def pack(data):
    """pack bytes for sending to client"""
    frame_head = bytearray(2)
    
    # set final fragment
    frame_head[0] = set_bit(frame_head[0], 7)
    
    # set opcode 1 = text
    frame_head[0] = set_bit(frame_head[0], 0)
    
    # payload length
    assert len(data) < 126, "haven't implemented that yet"
    frame_head[1] = len(data)
    
    # add data
    frame = frame_head + data.encode('utf-8')
    print(list(hex(b) for b in frame))
    return frame

def receive(s):
    """receive data from client"""
    
    # read the first two bytes
    frame_head = s.recv(2)
    
    # very first bit indicates if this is the final fragment
    print("final fragment: ", is_bit_set(frame_head[0], 7))
    
    # bits 4-7 are the opcode (0x01 -> text)
    print("opcode: ", frame_head[0] & 0x0f)
    
    # mask bit, from client will ALWAYS be 1
    assert is_bit_set(frame_head[1], 7)
    
    # length of payload
    # 7 bits, or 7 bits + 16 bits, or 7 bits + 64 bits
    payload_length = frame_head[1] & 0x7F
    if payload_length == 126:
        raw = s.recv(2)
        payload_length = bytes_to_int(raw)
    elif payload_length == 127:
        raw = s.recv(8)
        payload_length = bytes_to_int(raw)
    print('Payload is {} bytes'.format(payload_length))
    
    """masking key
    All frames sent from the client to the server are masked by a
    32-bit nounce value that is contained within the frame
    """
    masking_key = s.recv(4)
    print("mask: ", masking_key, bytes_to_int(masking_key))
    
    # finally get the payload data:
    masked_data_in = s.recv(payload_length)
    data = bytearray(payload_length)
    
    # The ith byte is the XOR of byte i of the data with
    # masking_key[i % 4]
    for i, b in enumerate(masked_data_in):
        data[i] = b ^ masking_key[i%4]

    return data

def handle(s):
    client_request = s.recv(4096)
    
    # get to the key
    for line in client_request.splitlines():
        if b'Sec-WebSocket-Key:' in line:
            key = line.split(b': ')[1]
            break
    response_string = calculate_websocket_hash(key)
    
    header = '''HTTP/1.1 101 Switching Protocols\r
Upgrade: websocket\r
Connection: Upgrade\r
Sec-WebSocket-Accept: {}\r
\r
'''.format(response_string)
    s.send(header.encode())
    
    # this works
    print(receive(s))
    
    # this doesn't
    s.send(pack('Hello'))
    
    s.close()

s = socket.socket( socket.AF_INET, socket.SOCK_STREAM)
s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
s.bind(('', 9876))
s.listen(1)

while True:
    t,_ = s.accept()
    threading.Thread(target=handle, args = (t,)).start()

使用此基本测试页面(使用mod-pywebsocket)：

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <title>Web Socket Example</title>
    <meta charset="UTF-8">
</head>
<body>
    <div id="serveroutput"></div>
    <form id="form">
        <input type="text" value="Hello World!" id="msg" />
        <input type="submit" value="Send" onclick="sendMsg()" />
    </form>
<script>
    var form = document.getElementById('form');
    var msg = document.getElementById('msg');
    var output = document.getElementById('serveroutput');
    var s = new WebSocket("ws://"+window.location.hostname+":9876");
    s.onopen = function(e) {
        console.log("opened");
        out('Connected.');
    }
    s.onclose = function(e) {
        console.log("closed");
        out('Connection closed.');
    }
    s.onmessage = function(e) {
        console.log("got: " + e.data);
        out(e.data);
    }
    form.onsubmit = function(e) {
        e.preventDefault();
        msg.value = '';
        window.scrollTop = window.scrollHeight;
    }
    function sendMsg() {
        s.send(msg.value);
    }
    function out(text) {
        var el = document.createElement('p');
        el.innerHTML = text;
        output.appendChild(el);
    }
    msg.focus();
</script>
</body>
</html>

它接收数据并正确地对其进行解释，但我无法使传输路径正常工作。

作为对套接字写"Hello“的测试，上面的程序计算要写入套接字的字节如下：

['0x81', '0x5', '0x48', '0x65', '0x6c', '0x6c', '0x6f']

与RFC的第5.7节中给出的十六进制值相匹配。不幸的是，这个框架从未出现在Chrome的开发工具中。

知道我错过了什么吗？还是目前正在运行的Python3 websocket示例？

sockets

python-3.x

websocket

mod-pywebsocket

回答 1

Stack Overflow用户

回答已采纳

发布于 2012-10-15 20:22:13

当我尝试在Lion上与Safari 6.0.1中的python代码交谈时，我得到了

Unexpected LF in Value at ...

在Javascript控制台中。我还从Python代码中获得了一个IndexError异常。

当我在Lion上与ChromeVersion24.0.1290.1dev中的python代码交谈时，我没有发现任何Javascript错误。在您的javascript中，调用onopen()和onclose()方法，但不调用onmessage()。python代码不会抛出任何异常，并且似乎有接收消息并发送它的响应，即您所看到的行为。

因为Safari不喜欢你头上拖着的LF，所以我试着删除它，也就是说

header = '''HTTP/1.1 101 Switching Protocols\r
Upgrade: websocket\r
Connection: Upgrade\r
Sec-WebSocket-Accept: {}\r
'''.format(response_string)

当我做此更改时，Chrome能够看到您的响应消息，即

got: Hello

显示在javascript控制台中。

狩猎旅行还是不起作用。现在，当我试图发送信息时，它提出了一个不同的问题。

websocket.html:36 INVALID_STATE_ERR: DOM Exception 11: An attempt was made to use an object that is not, or is no longer, usable.

javascript websocket事件处理程序从来没有触发过，而且我仍然看到python的IndexError异常。

总之。您的Python代码没有使用Chrome，因为您的头响应中有一个额外的LF。还有其他的原因，因为Chrome的代码不适用于Safari。

更新

我已经解决了潜在的问题，现在已经有了在Safari和Chrome中工作的例子。

base64.encodestring()总是在它的返回中添加一个尾随\n。这是Safari抱怨的LF的来源。

对.strip()的返回值调用calculate_websocket_hash，并使用原始的标头模板在Safari和Chrome上正确工作。

票数 7

页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持

原文链接：

https://stackoverflow.com/questions/12879274

复制

相似问题

问Python 3中的Websocket实现
EN

回答 1

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问Python 3中的Websocket实现EN

回答 1

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问Python 3中的Websocket实现
EN