ssl --- socket 物件的 TLS/SSL 包裝器¶
原始碼：Lib/ssl.py
這個模組向用戶端及伺服器端提供了對於網路 socket 的傳輸層安全性協定（或稱為「安全通訊協定 (Secure Sockets Layer)」）加密及身分驗證功能。這個模組使用 OpenSSL 套件。
This is an optional module. If it is missing from your copy of CPython, look for documentation from your distributor (that is, whoever provided Python to you). If you are the distributor, see 可選模組的需求.
備註
由於呼叫了作業系統的 socket APIs，有些行為會根據平台而有所不同。OpenSSL 的安裝版本也會對模組的運作產生影響。例如，OpenSSL 版本 1.1.1 附帶 TLSv1.3。
警告
在使用此模組之前，請閱讀 Security considerations。如果不這樣做，可能會產生錯誤的安全性認知，因為 ssl 模組的預設設定未必適合你的應用程式。
可用性: not WASI.
此模組在 WebAssembly 平台上不起作用或無法使用。更多資訊請參閱 WebAssembly 平台。
這個章節記錄了 ssl 模組的物件及函式；關於 TSL、SSL、以及憑證的更多資訊，可以去參考此章節底部的「詳情」部分。
此模組提供了一個 ssl.SSLSocket 類別，它是從 socket.socket 衍生出來的，並且提供類似 socket 的包裝器，讓使用 SSL 進行資料傳輸時，可以進行資料的加密及解密。它也提供了一些額外的方法，如 getpeercert()，用於取得連結另一端的憑證；以及 cipher()，用於搜尋用於安全連接的加密方法 (cipher)；和 get_verified_chain()、get_unverified_chain() 能用於取得憑證鏈。
對於更複雜的應用程式，ssl.SSLContext 類別有助於管理設定及認證，然後可以透過 SSLContext.wrap_socket() 方法建立的 SSL socket 繼承這些設定和認證。
在 3.5.3 版的變更: 更新以支援與 OpenSSL 1.1.0 進行連結
在 3.6 版的變更: OpenSSL 0.9.8, 1.0.0 及 1.0.1 版本已被棄用且不再支援。在未來 ssl 模組將需要至少 OpenSSL 1.0.2 版本或 1.1.0 版本。
在 3.10 版的變更: PEP 644 已經被實作。ssl 模組需要 OpenSSL 1.1.1 以上的版本才能使用。
使用已經被棄用的常數或函式將會導致棄用警示。
函式、常數與例外¶
Socket 建立¶
SSLSocket 實例必須使用 SSLContext.wrap_socket() 方法來建立。輔助函式 create_default_context() 會回傳有安全預設設定的新語境 (context)。
使用預設語境及 IPv4/IPv6 雙協定堆疊的用戶端 socket 範例：
import socket
import ssl
hostname = 'www.python.org'
context = ssl.create_default_context()
with socket.create_connection((hostname, 443)) as sock:
with context.wrap_socket(sock, server_hostname=hostname) as ssock:
print(ssock.version())
使用自訂語境及 IPv4 的用戶端 socket範例：
hostname = 'www.python.org'
# PROTOCOL_TLS_CLIENT requires valid cert chain and hostname
context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
context.load_verify_locations('path/to/cabundle.pem')
with socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0) as sock:
with context.wrap_socket(sock, server_hostname=hostname) as ssock:
print(ssock.version())
在本地 IPv4 上監聽伺服器 socket 的範例：
context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
context.load_cert_chain('/path/to/certchain.pem', '/path/to/private.key')
with socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0) as sock:
sock.bind(('127.0.0.1', 8443))
sock.listen(5)
with context.wrap_socket(sock, server_side=True) as ssock:
conn, addr = ssock.accept()
...
語境建立¶
一個可以幫忙建立出 SSLContext 物件以用於一般目的的方便函式。
- ssl.create_default_context(purpose=Purpose.SERVER_AUTH, *, cafile=None, capath=None, cadata=None)¶
回傳一個新的
SSLContext物件，使用給定 purpose 的預設值。這些設定是由ssl模組選擇，通常比直接呼叫SSLContext建構函式有更高的安全性。cafile, capath, cadata 是用來選擇用於憑證認證的 CA 憑證，就像
SSLContext.load_verify_locations()一樣。如果三個值都是None，此函式會自動選擇系統預設的 CA 憑證。這些設定包含：
PROTOCOL_TLS_CLIENT或PROTOCOL_TLS_SERVER、OP_NO_SSLv2、以及OP_NO_SSLv3，使用高等加密套件但不包含 RC4 和未經身份驗證的加密套件。如果將 purpose 設定為SERVER_AUTH，則會把verify_mode設為CERT_REQUIRED並使用設定的 CA 憑證(當 cafile、capath 或 cadata 其中一個值有被設定時) 或使用預設的 CA 憑證SSLContext.load_default_certs()。當系統有支援
keylog_filename並且有設定環境變數SSLKEYLOGFILE時create_default_context()會啟用密鑰日誌記錄 (logging)。The default settings for this context include
VERIFY_X509_PARTIAL_CHAINandVERIFY_X509_STRICT. These make the underlying OpenSSL implementation behave more like a conforming implementation of RFC 5280, in exchange for a small amount of incompatibility with older X.509 certificates.備註
協定、選項、加密方式和其它設定可以在不捨棄舊值的情況下直接更改成新的值，這些值代表了在相容性和安全性之間取得的合理平衡。
如果你的應用程式需要特殊的設定，你應該要自行建立一個
SSLContext並自行調整設定。備註
如果你發現某些舊的用戶端或伺服器常適用此函式建立的
SSLContext連線時，收到 "Protocol or cipher suite mismatch" 錯誤，這可能是因為他們的系統僅支援 SSL3.0，然而 SSL3.0 已被此函式用OP_NO_SSLv3排除。目前廣泛認為 SSL3.0 已經被完全破解。如果你仍然希望在允許 SSL3.0 連線的情況下使用此函式，可以使用下面的方法：ctx = ssl.create_default_context(Purpose.CLIENT_AUTH) ctx.options &= ~ssl.OP_NO_SSLv3
備註
This context enables
VERIFY_X509_STRICTby default, which may reject pre-RFC 5280 or malformed certificates that the underlying OpenSSL implementation otherwise would accept. While disabling this is not recommended, you can do so using:ctx = ssl.create_default_context() ctx.verify_flags &= ~ssl.VERIFY_X509_STRICT
在 3.4 版被加入.
在 3.4.4 版的變更: 把 RC4 從預設加密方法字串中捨棄。
在 3.6 版的變更: 把 ChaCha20/Poly1305 加入預設加密方法字串。
把 3DES 從預設加密方法字串中捨棄。
在 3.8 版的變更: 增加了
SSLKEYLOGFILE對密鑰日誌記錄 (logging) 的支援。在 3.10 版的變更: 目前語境使用
PROTOCOL_TLS_CLIENT協定或PROTOCOL_TLS_SERVER協定而非通用的PROTOCOL_TLS。在 3.13 版的變更: The context now uses
VERIFY_X509_PARTIAL_CHAINandVERIFY_X509_STRICTin its default verify flags.
例外¶
- exception ssl.SSLError¶
引發由底層 SSL 實作（目前由 OpenSSL 函式庫提供）所引發的錯誤訊息。這表示在覆蓋底層網路連線的高階加密和身份驗證層中存在一些問題。這項錯誤是
OSError的一個子型別。SSLError實例的錯誤程式代碼和訊息是由 OpenSSL 函式庫提供。在 3.3 版的變更:
SSLError曾經是socket.error的一個子型別。- library¶
一個字串符號 (string mnemonic)，用來指定發生錯誤的 OpenSSL 子模組，如：
SSL、PEM或X509。可能值的範圍取決於 OpenSSL 的版本。在 3.3 版被加入.
- reason¶
一個字串符號，用來指定發生錯誤的原因，如：
CERTIFICATE_VERIFY_FAILED。可能值的範圍取決於 OpenSSL 的版本。在 3.3 版被加入.
- exception ssl.SSLZeroReturnError¶
一個
SSLError的子類別，當嘗試去讀寫已經被完全關閉的 SSL 連線時會被引發。請注意，這並不表示底層傳輸（例如 TCP）已經被關閉。在 3.3 版被加入.
- exception ssl.SSLWantReadError¶
一個
SSLError的子類別，當嘗試去讀寫資料前，底層 TCP 傳輸需要先接收更多資料時會由非阻塞的 SSL socket 引發該錯誤。在 3.3 版被加入.
- exception ssl.SSLWantWriteError¶
一個
SSLError的子類別，當嘗試去讀寫資料前，底層 TCP 傳輸需要先發送更多資料時會由非阻塞的 SSL socket 引發該錯誤。在 3.3 版被加入.
- exception ssl.SSLSyscallError¶
一個
SSLError的子類別，當嘗試去操作 SSL socket 時有系統錯誤產生會引發此錯誤。不幸的是，目前沒有任何簡單的方法可以去檢查原本的的 errno 編號。在 3.3 版被加入.
- exception ssl.SSLEOFError¶
一個
SSLError的子類別，當 SSL 連線被突然終止時會引發此錯誤。通常，當此錯誤發生時，你不該再去重新使用底層傳輸。在 3.3 版被加入.
- exception ssl.SSLCertVerificationError¶
當憑證驗證失敗時會引發的一個
SSLError子類別。在 3.7 版被加入.
- verify_code¶
一個表示驗證錯誤的錯誤數值編號。
- verify_message¶
一個人類可讀的驗證錯誤字串。
- exception ssl.CertificateError¶
-
在 3.7 版的變更: 此例外現在是
SSLCertVerificationError的別名。
隨機產生¶
- ssl.RAND_bytes(num, /)¶
回傳 num 個加密性強的偽隨機位元組。如果 PRNG 未使用足夠的資料做為隨機種子 (seed) 或是目前的 RAND 方法不支援該操作則會導致
SSLError錯誤。RAND_status()函式可以用來檢查 PRNG 函式，而RAND_add()則可以用來為 PRNG 設定隨機種子。在幾乎所有的應用程式中，
os.urandom()會是較好的選擇。請閱讀維基百科的密碼學安全偽隨機數產生器 (CSPRNG)文章來了解密碼學安全偽隨機數產生器的需求。
在 3.3 版被加入.
- ssl.RAND_status()¶
如果 SSL 偽隨機數產生器已經使用「足夠的」隨機性進行隨機種子生成，則回傳
True，否則回傳False。你可以使用ssl.RAND_egd()函式和ssl.RAND_add()函式來增加偽隨機數產生器的隨機性。
認證處理¶
- ssl.cert_time_to_seconds(cert_time)¶
回傳自紀元以來的秒數，給定的
cert_time字串表示憑證的 "notBefore" 或 "notAfter" 日期，字串採用"%b %d %H:%M:%S %Y %Z"格式（C 語言區域設定）。以下是一個範例：
>>> import ssl >>> import datetime as dt >>> timestamp = ssl.cert_time_to_seconds("Jan 5 09:34:43 2018 GMT") >>> timestamp 1515144883 >>> print(dt.datetime.fromtimestamp(timestamp, dt.UTC)) 2018-01-05 09:34:43+00:00
"notBefore" 或 "notAfter" 日期必須使用 GMT (RFC 5280)。
在 3.5 版的變更: 將輸入的時間直譯為 UTC 時間，如輸入字串中指定的 'GMT' 時區。在之前是使用本地的時區。回傳一個整數（在輸入格式中不包括秒的小數部分）。
- ssl.get_server_certificate(addr, ssl_version=PROTOCOL_TLS_CLIENT, ca_certs=None[, timeout])¶
輸入使用 SSL 保護的伺服器的地址
addr，輸入形式為一個 pair (hostname, port-number)，取得該伺服器的憑證，並以 PEM 編碼字串的形式回傳。如果指定了ssl_version，則使用指定的 SSL 協定來嘗試與伺服器連線。如果指定 ca_certs，則它應該是一個包含根憑證列表的檔案，並與SSLContext.load_verify_locations()中的參數 cafile 所使用的格式相同。此呼叫將嘗試使用該組根憑證對伺服器憑證進行驗證，如果驗證失敗，呼叫將失敗。可以使用timeout參數指定超時時間。在 3.3 版的變更: 此函式現在是與 IPv6 相容的。
在 3.5 版的變更: 預設的 ssl_version 已經從
PROTOCOL_SSLv3改為PROTOCOL_TLS，已確保與現今的伺服器有最大的相容性。在 3.10 版的變更: 新增 timeout 參數。
- ssl.DER_cert_to_PEM_cert(der_cert_bytes)¶
給定一個以 DER 編碼的位元組 blob 作為憑證，回傳以 PEM 編碼字串版本的相同憑證。
- ssl.PEM_cert_to_DER_cert(pem_cert_string)¶
給定一個以 ASCII PEM 的字串作為憑證，回傳以 DER 編碼的位元組序列的相同憑證。
- ssl.get_default_verify_paths()¶
回傳一個具有 OpenSSL 的預設 cafile 和 capath 路徑的附名元組。這些路徑與
SSLContext.set_default_verify_paths()使用的相同。回傳值是一個 named tupleDefaultVerifyPaths：cafile- 解析後的 cafile 路徑，如果檔案不存在則為None，capath- 解析後的 capath 路徑，如果目錄不存在則為None，openssl_cafile_env- 指向 cafile 的 OpenSSL 環境密鑰，openssl_cafile- hard coded 的 cafile 路徑，openssl_capath_env- 指向 capath 的 OpenSSL 環境密鑰，openssl_capath- hard coded 的 capath 目錄路徑
在 3.4 版被加入.
- ssl.enum_certificates(store_name)¶
從 Windows 的系統憑證儲存庫中搜尋憑證。store_name 可以是
CA、ROOT或MY的其中一個。Windows 也可能會提供額外的憑證儲存庫。此函式會回傳一個元組 (cert_bytes, encoding_type, trust) 串列。encoding_type 指定了 cert_bytes 的編碼格式。它可以是用來表示 X.509 ASN.1 資料的
x509_asn或是用來表示 PKCS#7 ASN.1 資料的pkcs_7_asn。Trust 透過一組 OIDS 來指定憑證的用途，或是如果憑證對所有用途都可以使用則回傳True。範例：
>>> ssl.enum_certificates("CA") [(b'data...', 'x509_asn', {'1.3.6.1.5.5.7.3.1', '1.3.6.1.5.5.7.3.2'}), (b'data...', 'x509_asn', True)]
可用性: Windows.
在 3.4 版被加入.
常數¶
所有的常數現在都是
enum.IntEnum或enum.IntFlag的集合。在 3.6 版被加入.
- ssl.CERT_NONE¶
SSLContext.verify_mode可能的值。除了PROTOCOL_TLS_CLIENT外，這是預設的模式。對於用戶端的 sockets，幾乎任何憑證都能被允許。驗證錯誤，像是不被信任或是過期的憑證，會被忽略並不會中止 TLS/SSL 握手。在伺服器模式下，不會從用戶端請求任何憑證，所以用戶端不用發送任何用於用戶端憑證身分驗證的憑證。
參閱下方 Security considerations 的討論。
- ssl.CERT_OPTIONAL¶
SSLContext.verify_mode可能的值。在用戶端模式下，CERT_OPTIONAL具有與CERT_REQUIRED相同的含意。對於客戶端 sockets 推薦改用CERT_REQUIRED。在伺服器模式下，客戶憑證請求會被發送給用戶端。用戶端可以選擇忽略請求或是選擇發送憑證來執行 TLS 用戶端憑證身分驗證。如果用戶端選擇發送憑證，則會對其進行驗證。任何驗證錯誤都會立刻終止 TLS 握手。
使用此設定需要將一組有效的 CA 憑證傳送給
SSLContext.load_verify_locations()。
- ssl.CERT_REQUIRED¶
SSLContext.verify_mode可能的值。在這個模式下，需要從 socket 連線的另一端取得憑證；如果未提供憑證或是驗證失敗，則將會導致SSLError。此模式不能在用戶端模式下對憑證進行驗證，因為它無法去配對主機名稱。check_hostname也必須被開起來來驗證憑證的真實性。PROTOCOL_TLS_CLIENT會使用CERT_REQUIRED並預設開啟check_hostname。對於 socket 伺服器，此模式會提供強制的 TLS 用戶端憑證驗證。用戶端憑證請求會被發送給用戶端並且用戶端必須提供有效且被信任的憑證。
使用此設定需要將一組有效的 CA 憑證傳送給
SSLContext.load_verify_locations()。
- class ssl.VerifyMode¶
enum.IntEnum為 CERT_* 常數的一個集合。在 3.6 版被加入.
- ssl.VERIFY_DEFAULT¶
SSLContext.verify_flags可能的值。在此模式下，不會檢查憑證吊銷列表 (CRLs)。預設的 OpenSSL 並不會請求及驗證 CRLs。在 3.4 版被加入.
- ssl.VERIFY_CRL_CHECK_LEAF¶
SSLContext.verify_flags可能的值。在此模式下，只會檢查同等的憑證而不會去檢查中間的 CA 憑證。此模式需要提供由對等憑證發行者 (它的直接上級 CA) 的有效的 CRL 簽名。如果沒有用SSLContext.load_verify_locations載入適當的 CRL，則會驗證失敗。在 3.4 版被加入.
- ssl.VERIFY_CRL_CHECK_CHAIN¶
SSLContext.verify_flags可能的值。在此模式下，會檢查對等憑證鍊中所有憑證的 CRLs。在 3.4 版被加入.
- ssl.VERIFY_X509_STRICT¶
SSLContext.verify_flags可能的值，用來禁用已損壞的 X.509 憑證的解決方法。在 3.4 版被加入.
- ssl.VERIFY_ALLOW_PROXY_CERTS¶
SSLContext.verify_flags可能的值，用來啟用憑證代理驗證。在 3.10 版被加入.
- ssl.VERIFY_X509_TRUSTED_FIRST¶
SSLContext.verify_flags可能的值。它指示 OpenSSL 在構建信任鍊來驗證憑證時會優先使用被信任的憑證。此旗標預設開啟。在 3.4.4 版被加入.
- ssl.VERIFY_X509_PARTIAL_CHAIN¶
SSLContext.verify_flags可能的值。它指示 OpenSSL 接受信任儲存中的中間 CAs 作為信任錨，就像自簽名的根 CA 憑證。這樣就能去信任中間 CA 所頒發的憑證，而不一定非要去信任其祖先的根 CA。在 3.10 版被加入.
- class ssl.VerifyFlags¶
enum.IntFlag為 VERIFY_* 常數的其中一個集合。在 3.6 版被加入.
- ssl.PROTOCOL_TLS¶
選擇用戶端及伺服器均可以支援最高協定版本。儘管名稱只有 「TLS」，但實際上「SSL」和「TLS」均可以選擇。
在 3.6 版被加入.
在 3.10 版之後被棄用: TLS 的用戶端及伺服器端需要不同的預設值來實現安全通訊。通用的 TLS 協定常數已被廢除，並改用
PROTOCOL_TLS_CLIENT和PROTOCOL_TLS_SERVER。
- ssl.PROTOCOL_TLS_CLIENT¶
自動協商用戶端和伺服器服務器都支援的最高協定版本，並配置用戶端語境連線。該協定預設啟用
CERT_REQUIRED和check_hostname。在 3.6 版被加入.
- ssl.PROTOCOL_TLS_SERVER¶
自動協商用戶端和伺服器都支援的最高協定版本，並配置用戶端語境連線。
在 3.6 版被加入.
- ssl.PROTOCOL_SSLv23¶
PROTOCOL_TLS的別名。在 3.6 版之後被棄用: 請改用
PROTOCOL_TLS。
- ssl.PROTOCOL_SSLv3¶
選擇第三版的 SSL 做為通道加密協定。
如果 OpenSSL 是用
no-ssl3編譯的，則此項協定無法使用。警告
第三版的 SSL 是不安全的，強烈建議不要使用。
在 3.6 版之後被棄用: OpenSSL 已經終止了所有特定版本的協定。請改用預設的
PROTOCOL_TLS_SERVER協定或帶有SSLContext.minimum_version和SSLContext.maximum_version的PROTOCOL_TLS_CLIENT。
- ssl.PROTOCOL_TLSv1¶
選擇 1.0 版的 TLS 做為通道加密協定。
在 3.6 版之後被棄用: OpenSSL 已經將所有版本特定的協定棄用。
- ssl.PROTOCOL_TLSv1_1¶
選擇 1.1 版的 TLS 做為通道加密協定。只有在 1.0.1 版本以上的 OpenSSL 才可以選用。
在 3.4 版被加入.
在 3.6 版之後被棄用: OpenSSL 已經將所有版本特定的協定棄用。
- ssl.PROTOCOL_TLSv1_2¶
選擇 1.2 版的 TLS 做為通道加密協定。只有在 1.0.1 版本以上的 OpenSSL 才可以選用。
在 3.4 版被加入.
在 3.6 版之後被棄用: OpenSSL 已經將所有版本特定的協定棄用。
- ssl.OP_ALL¶
啟用對 SSL 實作時所產生的各種錯誤的緩解措施。此選項預設被設定。它不一定設定與 OpenSSL 的
SSL_OP_ALL常數相同的旗標。在 3.2 版被加入.
- ssl.OP_NO_SSLv2¶
防止 SSLv2 連線。此選項只可以跟
PROTOCOL_TLS一起使用。它會防止同級 (peer)選用 SSLv2 做為協定版本。在 3.2 版被加入.
在 3.6 版之後被棄用: SSLv2 已被棄用
- ssl.OP_NO_SSLv3¶
防止 SSLv3 連線。此選項只可以跟
PROTOCOL_TLS一起使用。它會防止同級選用 SSLv3 做為協定版本。在 3.2 版被加入.
在 3.6 版之後被棄用: SSLv3 已被棄用
- ssl.OP_NO_TLSv1¶
防止 TLSv1 連線。此選項只可以跟
PROTOCOL_TLS一起使用。它會防止同級選用 TLSv1 做為協定版本。在 3.2 版被加入.
在 3.7 版之後被棄用: 該選項自從 OpenSSL 1.1.0 以後已被棄用，請改用新的
SSLContext.minimum_version及SSLContext.maximum_version代替。
- ssl.OP_NO_TLSv1_1¶
防止 TLSv1.1 連線。此選項只可以跟
PROTOCOL_TLS一起使用。它會防止同級選用 TLSv1.1 做為協定版本。只有 1.0.1 版後的 OpenSSL 版本才能使用。在 3.4 版被加入.
在 3.7 版之後被棄用: 此選項自 OpenSSL 1.1.0 版已被棄用。
- ssl.OP_NO_TLSv1_2¶
防止 TLSv1.2 連線。此選項只可以跟
PROTOCOL_TLS一起使用。它會防止同級選用 TLSv1.2 做為協定版本。只有 1.0.1 版後的 OpenSSL 版本才能使用。在 3.4 版被加入.
在 3.7 版之後被棄用: 此選項自 OpenSSL 1.1.0 版已被棄用。
- ssl.OP_NO_TLSv1_3¶
防止 TLSv1.3 連線。此選項只可以跟
PROTOCOL_TLS一起使用。它會防止同級選用 TLSv1.3 做為協定版本。TSL1.3 只適用於 1.1.1 版以後的 OpenSSL。當使用 Python 編譯舊版的 OpenSSL 時，該標志預設為 0。在 3.6.3 版被加入.
在 3.7 版之後被棄用: 此選項自 OpenSSL 1.1.0 以後已被棄用。它被添加到 2.7.15 和 3.6.3 中，以向後相容 OpenSSL 1.0.2。
- ssl.OP_NO_RENEGOTIATION¶
停用所有在 TLSv1.2 及更早版本的重協商 (renegotiation)。不發送 HelloRequest 訊息，並忽略透過 ClientHello 的重協商請求。
此選項僅適用於 OpenSSL 1.1.0h 及更新版本。
在 3.7 版被加入.
- ssl.OP_CIPHER_SERVER_PREFERENCE¶
使用伺服器的加密方法名稱字串排序優先順序，而不是用戶端的。此選項並不會影響到用戶端及 SSLv2 伺服器的 sockets。
在 3.3 版被加入.
- ssl.OP_SINGLE_DH_USE¶
防止對不同的 SSL 會談重複使用相同的 DH 密鑰。這會加強向前保密但需要更多的運算資源。此選項只適用於伺服器 sockets。
在 3.3 版被加入.
- ssl.OP_SINGLE_ECDH_USE¶
防止對不同的 SSL 會談重複使用相同的 ECDH 密鑰。這會加強向前保密但需要更多的運算資源。此選項只適用於伺服器 sockets。
在 3.3 版被加入.
- ssl.OP_ENABLE_MIDDLEBOX_COMPAT¶
在 TLS 1.3 握手中發送虛擬的變更加密方法規範 (CCS) 消息，以使 TLS 1.3 連接看起來更像 TLS 1.2 連線。
此選項僅適用於 OpenSSL 1.1.1 及更新版本。
在 3.8 版被加入.
- ssl.OP_NO_COMPRESSION¶
在 SSL 通道上禁用壓縮。如果應用程序協定支援自己的壓縮方案，這會很有用。
在 3.3 版被加入.
- class ssl.Options¶
enum.IntFlag為 OP_* 常數中的一個集合。
- ssl.OP_NO_TICKET¶
防止用戶端請求會談票據。
在 3.6 版被加入.
- ssl.OP_IGNORE_UNEXPECTED_EOF¶
忽略意外關閉的 TLS 連線。
此選項僅適用於 OpenSSL 3.0.0 及更新版本。
在 3.10 版被加入.
- ssl.OP_ENABLE_KTLS¶
允許使用 TLS 核心。要想受益於該功能，OpenSSL 必須編譯為支援該功能，並且想使用的加密套件及擴充套件也必須被該功能支援 (該功能所支援的列表可能會因平台及核心而有所差異)。
請注意當允許使用 TLS 核心時，一些加密操作將直接由核心執行而不是經由任何由可用的 OpenSSL 所提供的程序，而這可能並非你所想使用的，例如：當應用程式要求所有的加密操作由 FIPS 提供執行。
此選項僅適用於 OpenSSL 3.0.0 及更新版本。
在 3.12 版被加入.
- ssl.OP_LEGACY_SERVER_CONNECT¶
只允許 OpenSSL 與未修補的伺服器進行遺留 (legacy) 不安全重協商。
在 3.12 版被加入.
- ssl.HAS_NEVER_CHECK_COMMON_NAME¶
OpenSSL 函式庫是否內建支援不檢查主題通用名稱及
SSLContext.hostname_checks_common_name是否可寫。在 3.7 版被加入.
- ssl.HAS_ECDH¶
OpenSSL 函式庫是否內建支援基於橢圓曲線的 (Elliptic Curve-based) Diffie-Hellman 金鑰交換。此回傳值應該要為 true 除非發布者明確禁用此功能。
在 3.3 版被加入.
- ssl.HAS_NPN¶
OpenSSL 函式庫是否內建支援 下一代協定協商 該功能在應用層協定協商 中有描述。當此值為 true 時，你可以使用
SSLContext.set_npn_protocols()方法來公告你想支援的協定。在 3.3 版被加入.
- ssl.HAS_SSLv2¶
此 OpenSSL 函式庫是否內建支援 SSL 2.0 協定。
在 3.7 版被加入.
- ssl.HAS_SSLv3¶
此 OpenSSL 函式庫是否內建支援 SSL 3.0 協定。
在 3.7 版被加入.
- ssl.HAS_TLSv1¶
此 OpenSSL 函式庫是否內建支援 TLS 1.0 協定。
在 3.7 版被加入.
- ssl.HAS_TLSv1_1¶
此 OpenSSL 函式庫是否內建支援 TLS 1.1 協定。
在 3.7 版被加入.
- ssl.HAS_TLSv1_2¶
此 OpenSSL 函式庫是否內建支援 TLS 1.2 協定。
在 3.7 版被加入.
- ssl.HAS_TLSv1_3¶
此 OpenSSL 函式庫是否內建支援 TLS 1.3 協定。
在 3.7 版被加入.
- ssl.HAS_PSK¶
此 OpenSSL 函式庫是否內建支援 TLS-PSK。
在 3.13 版被加入.
- ssl.HAS_PHA¶
此 OpenSSL 函式庫是否內建支援 TLS-PHA。
在 3.14 版被加入.
- ssl.CHANNEL_BINDING_TYPES¶
支援的 TLS 通道綁定類型列表。列表中的字串可以作為
SSLSocket.get_channel_binding()的參數。在 3.3 版被加入.
- ssl.OPENSSL_VERSION¶
直譯器所加載的 OpenSSL 函式庫的版本字串:
>>> ssl.OPENSSL_VERSION 'OpenSSL 1.0.2k 26 Jan 2017'
在 3.2 版被加入.
- ssl.OPENSSL_VERSION_INFO¶
代表 OpenSSL 函式庫版本資訊的五個整數的元組：
>>> ssl.OPENSSL_VERSION_INFO (1, 0, 2, 11, 15)
在 3.2 版被加入.
- ssl.OPENSSL_VERSION_NUMBER¶
OpenSSL 函式庫的初始版本，以單一整數表示:
>>> ssl.OPENSSL_VERSION_NUMBER 268443839 >>> hex(ssl.OPENSSL_VERSION_NUMBER) '0x100020bf'
在 3.2 版被加入.
- ssl.ALERT_DESCRIPTION_HANDSHAKE_FAILURE¶
- ssl.ALERT_DESCRIPTION_INTERNAL_ERROR¶
- ALERT_DESCRIPTION_*
來自 RFC 5246 和其他文件的警報描述。IANA TLS Alert Registry 包含了此列表以及其含義定義所在的 RFC 的引用。
被用來做為
SSLContext.set_servername_callback()中回呼函式的回傳值。在 3.4 版被加入.
- class ssl.AlertDescription¶
enum.IntEnum為 ALERT_DESCRIPTION_* 常數中的一個集合。在 3.6 版被加入.
- Purpose.SERVER_AUTH¶
create_default_context()和SSLContext.load_default_certs()的選項。此值表示該語境可能會用於驗證網頁伺服器 (因此它將用於建立用戶端 socket）。在 3.4 版被加入.
- Purpose.CLIENT_AUTH¶
create_default_context()和SSLContext.load_default_certs()的選項。此值表示該語境可能會用於驗證網頁用戶端 (因此，它將用於建立伺服器端的 socket）。在 3.4 版被加入.
- class ssl.SSLErrorNumber¶
enum.IntEnum為 SSL_ERROR_* 常數中的一個集合。在 3.6 版被加入.
- class ssl.TLSVersion¶
用於
SSLContext.maximum_version和SSLContext.minimum_version的 SSL 和 TLS 版本enum.IntEnum集合。