Update wolfSSL to the latest version(v.4.4.0) (#186)

* deleted old version wolfSSL before updating * updated wolfSSL to the latest version(v4.4.0) * updated wolfSSL to the latest version(v4.4.0) * added macros for timing resistance Co-authored-by: RichardBarry <3073890+RichardBarry@users.noreply.github.com> Co-authored-by: Ming Yue <mingyue86010@gmail.com>
2025-12-16 16:45:08 -05:00 · 2020-08-08 07:58:14 +09:00 · 2020-08-08 07:58:14 +09:00 · 94aa31c3cb
commit 94aa31c3cb
parent 68518f5866
1185 changed files with 837519 additions and 72138 deletions
--- a/FreeRTOS-Plus/Source/WolfSSL/wrapper/python/wolfssl/docs/usage.rst
+++ b/FreeRTOS-Plus/Source/WolfSSL/wrapper/python/wolfssl/docs/usage.rst
@ -0,0 +1,87 @@
+Basic Usage
+===========
+
+The SSL/TLS protocol works securing an underlying TCP connection, this module
+adds the secure layer around the Python standard library 
+`socket <https://docs.python.org/3.6/library/socket.html>`_ module.
+
+There are three different paths to secure a socket in this module:
+
+* Using the top level function wolfssl.wrap_socket();
+* Using the method wrap_socket() from a SSLContext instance;
+* Creating an SSLSocket object from the scratch.
+
+Note 1:
+    It is possible to use the same SSLContext for multiple SSLSockets to save
+    time and resources.
+
+Note 2:
+    Each path provides its own options for fine-tuning the securint parameters.
+    Check them out in the API documentation.
+
+
+Using the top level function wolfssl.wrap_socket()
+--------------------------------------------------
+
+.. code-block:: python
+
+    >>> import socket
+    >>> import wolfssl
+    >>>
+    >>> sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0)
+    >>>
+    >>> secure_socket = wolfssl.wrap_socket(sock)
+    >>>
+    >>> secure_socket.connect(("www.python.org", 443))
+    >>>
+    >>> secure_socket.write(b"GET / HTTP/1.1\n\n")
+    >>>
+    >>> print(secure_socket.read())
+    b'HTTP/1.1 500 Domain Not Found\r\nServer: Varnish\r\nRetry-After: 0\r\ncontent-type: text/html\r\nCache-Control: private, no-cache\r\nconnection: keep-alive\r\nContent-Length: 179\r\nAccept-Ranges: bytes\r\nDate: Sun, 05 Feb 2017 21:26:48 GMT\r\nVia: 1.1 varnish\r\nConnection: keep-alive\r\n\r\n\n<html>\n<head>\n<title>Fastly error: unknown domain </title>\n</head>\n<body>\nFastly error: unknown domain: . Please check that this domain has been added to a service.</body></html>'
+    >>>
+    >>> secure_socket.close()
+
+
+Using the method wrap_socket() from a SSLContext instance
+---------------------------------------------------------
+
+.. code-block:: python
+
+    >>> import socket
+    >>> import wolfssl
+    >>>
+    >>> sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0)
+    >>>
+    >>> context = wolfssl.SSLContext(wolfssl.PROTOCOL_TLSv1_2)
+    >>>
+    >>> secure_socket = context.wrap_socket(sock)
+    >>>
+    >>> secure_socket.connect(("www.python.org", 443))
+    >>>
+    >>> secure_socket.write(b"GET / HTTP/1.1\n\n")
+    >>>
+    >>> print(secure_socket.read())
+    b'HTTP/1.1 500 Domain Not Found\r\nServer: Varnish\r\nRetry-After: 0\r\ncontent-type: text/html\r\nCache-Control: private, no-cache\r\nconnection: keep-alive\r\nContent-Length: 179\r\nAccept-Ranges: bytes\r\nDate: Sun, 05 Feb 2017 21:26:48 GMT\r\nVia: 1.1 varnish\r\nConnection: keep-alive\r\n\r\n\n<html>\n<head>\n<title>Fastly error: unknown domain </title>\n</head>\n<body>\nFastly error: unknown domain: . Please check that this domain has been added to a service.</body></html>'
+    >>>
+    >>> secure_socket.close()
+
+Creating an SSLSocket object from the scratch
+---------------------------------------------
+
+.. code-block:: python
+
+    >>> import socket
+    >>> import wolfssl
+    >>>
+    >>> sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0)
+    >>>
+    >>> secure_socket = wolfssl.SSLSocket(sock)
+    >>>
+    >>> secure_socket.connect(("www.python.org", 443))
+    >>>
+    >>> secure_socket.write(b"GET / HTTP/1.1\n\n")
+    >>>
+    >>> print(secure_socket.read())
+    b'HTTP/1.1 500 Domain Not Found\r\nServer: Varnish\r\nRetry-After: 0\r\ncontent-type: text/html\r\nCache-Control: private, no-cache\r\nconnection: keep-alive\r\nContent-Length: 179\r\nAccept-Ranges: bytes\r\nDate: Sun, 05 Feb 2017 21:26:48 GMT\r\nVia: 1.1 varnish\r\nConnection: keep-alive\r\n\r\n\n<html>\n<head>\n<title>Fastly error: unknown domain </title>\n</head>\n<body>\nFastly error: unknown domain: . Please check that this domain has been added to a service.</body></html>'
+    >>>
+    >>> secure_socket.close()