Shortcuts on this page
r m x toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1# Licensed under the LGPL: https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html
2# For details: https://github.com/pylint-dev/astroid/blob/main/LICENSE
3# Copyright (c) https://github.com/pylint-dev/astroid/blob/main/CONTRIBUTORS.txt
5"""Astroid hooks for the ssl library."""
7from astroid import nodes
8from astroid.brain.helpers import register_module_extender
9from astroid.builder import parse
10from astroid.const import PY312_PLUS
11from astroid.manager import AstroidManager
14def _verifyflags_enum() -> str:
15 enum = """
16 class VerifyFlags(_IntFlag):
17 VERIFY_DEFAULT = 0
18 VERIFY_CRL_CHECK_LEAF = 1
19 VERIFY_CRL_CHECK_CHAIN = 2
20 VERIFY_X509_STRICT = 3
21 VERIFY_X509_TRUSTED_FIRST = 4
22 VERIFY_ALLOW_PROXY_CERTS = 5
23 VERIFY_X509_PARTIAL_CHAIN = 6
24 """
25 return enum
28def _options_enum() -> str:
29 enum = """
30 class Options(_IntFlag):
31 OP_ALL = 1
32 OP_NO_SSLv2 = 2
33 OP_NO_SSLv3 = 3
34 OP_NO_TLSv1 = 4
35 OP_NO_TLSv1_1 = 5
36 OP_NO_TLSv1_2 = 6
37 OP_NO_TLSv1_3 = 7
38 OP_CIPHER_SERVER_PREFERENCE = 8
39 OP_SINGLE_DH_USE = 9
40 OP_SINGLE_ECDH_USE = 10
41 OP_NO_COMPRESSION = 11
42 OP_NO_TICKET = 12
43 OP_NO_RENEGOTIATION = 13
44 OP_ENABLE_MIDDLEBOX_COMPAT = 14
45 """
46 if PY312_PLUS:
47 enum += "OP_LEGACY_SERVER_CONNECT = 15"
48 return enum
51def ssl_transform() -> nodes.Module:
52 return parse(f"""
53 # Import necessary for conversion of objects defined in C into enums
54 from enum import IntEnum as _IntEnum, IntFlag as _IntFlag
56 from _ssl import OPENSSL_VERSION_NUMBER, OPENSSL_VERSION_INFO, OPENSSL_VERSION
57 from _ssl import _SSLContext, MemoryBIO
58 from _ssl import (
59 SSLError, SSLZeroReturnError, SSLWantReadError, SSLWantWriteError,
60 SSLSyscallError, SSLEOFError,
61 )
62 from _ssl import CERT_NONE, CERT_OPTIONAL, CERT_REQUIRED
63 from _ssl import txt2obj as _txt2obj, nid2obj as _nid2obj
64 from _ssl import RAND_status, RAND_add, RAND_bytes, RAND_pseudo_bytes
65 try:
66 from _ssl import RAND_egd
67 except ImportError:
68 # LibreSSL does not provide RAND_egd
69 pass
70 from _ssl import (OP_ALL, OP_CIPHER_SERVER_PREFERENCE,
71 OP_NO_COMPRESSION, OP_NO_SSLv2, OP_NO_SSLv3,
72 OP_NO_TLSv1, OP_NO_TLSv1_1, OP_NO_TLSv1_2,
73 OP_SINGLE_DH_USE, OP_SINGLE_ECDH_USE)
75 {"from _ssl import OP_LEGACY_SERVER_CONNECT" if PY312_PLUS else ""}
77 from _ssl import (ALERT_DESCRIPTION_ACCESS_DENIED, ALERT_DESCRIPTION_BAD_CERTIFICATE,
78 ALERT_DESCRIPTION_BAD_CERTIFICATE_HASH_VALUE,
79 ALERT_DESCRIPTION_BAD_CERTIFICATE_STATUS_RESPONSE,
80 ALERT_DESCRIPTION_BAD_RECORD_MAC,
81 ALERT_DESCRIPTION_CERTIFICATE_EXPIRED,
82 ALERT_DESCRIPTION_CERTIFICATE_REVOKED,
83 ALERT_DESCRIPTION_CERTIFICATE_UNKNOWN,
84 ALERT_DESCRIPTION_CERTIFICATE_UNOBTAINABLE,
85 ALERT_DESCRIPTION_CLOSE_NOTIFY, ALERT_DESCRIPTION_DECODE_ERROR,
86 ALERT_DESCRIPTION_DECOMPRESSION_FAILURE,
87 ALERT_DESCRIPTION_DECRYPT_ERROR,
88 ALERT_DESCRIPTION_HANDSHAKE_FAILURE,
89 ALERT_DESCRIPTION_ILLEGAL_PARAMETER,
90 ALERT_DESCRIPTION_INSUFFICIENT_SECURITY,
91 ALERT_DESCRIPTION_INTERNAL_ERROR,
92 ALERT_DESCRIPTION_NO_RENEGOTIATION,
93 ALERT_DESCRIPTION_PROTOCOL_VERSION,
94 ALERT_DESCRIPTION_RECORD_OVERFLOW,
95 ALERT_DESCRIPTION_UNEXPECTED_MESSAGE,
96 ALERT_DESCRIPTION_UNKNOWN_CA,
97 ALERT_DESCRIPTION_UNKNOWN_PSK_IDENTITY,
98 ALERT_DESCRIPTION_UNRECOGNIZED_NAME,
99 ALERT_DESCRIPTION_UNSUPPORTED_CERTIFICATE,
100 ALERT_DESCRIPTION_UNSUPPORTED_EXTENSION,
101 ALERT_DESCRIPTION_USER_CANCELLED)
102 from _ssl import (SSL_ERROR_EOF, SSL_ERROR_INVALID_ERROR_CODE, SSL_ERROR_SSL,
103 SSL_ERROR_SYSCALL, SSL_ERROR_WANT_CONNECT, SSL_ERROR_WANT_READ,
104 SSL_ERROR_WANT_WRITE, SSL_ERROR_WANT_X509_LOOKUP, SSL_ERROR_ZERO_RETURN)
105 from _ssl import VERIFY_CRL_CHECK_CHAIN, VERIFY_CRL_CHECK_LEAF, VERIFY_DEFAULT, VERIFY_X509_STRICT
106 from _ssl import HAS_SNI, HAS_ECDH, HAS_NPN, HAS_ALPN
107 from _ssl import _OPENSSL_API_VERSION
108 from _ssl import PROTOCOL_SSLv23, PROTOCOL_TLSv1, PROTOCOL_TLSv1_1, PROTOCOL_TLSv1_2
109 from _ssl import PROTOCOL_TLS, PROTOCOL_TLS_CLIENT, PROTOCOL_TLS_SERVER
111 class AlertDescription(_IntEnum):
112 ALERT_DESCRIPTION_ACCESS_DENIED = 0
113 ALERT_DESCRIPTION_BAD_CERTIFICATE = 1
114 ALERT_DESCRIPTION_BAD_CERTIFICATE_HASH_VALUE = 2
115 ALERT_DESCRIPTION_BAD_CERTIFICATE_STATUS_RESPONSE = 3
116 ALERT_DESCRIPTION_BAD_RECORD_MAC = 4
117 ALERT_DESCRIPTION_CERTIFICATE_EXPIRED = 5
118 ALERT_DESCRIPTION_CERTIFICATE_REVOKED = 6
119 ALERT_DESCRIPTION_CERTIFICATE_UNKNOWN = 7
120 ALERT_DESCRIPTION_CERTIFICATE_UNOBTAINABLE = 8
121 ALERT_DESCRIPTION_CLOSE_NOTIFY = 9
122 ALERT_DESCRIPTION_DECODE_ERROR = 10
123 ALERT_DESCRIPTION_DECOMPRESSION_FAILURE = 11
124 ALERT_DESCRIPTION_DECRYPT_ERROR = 12
125 ALERT_DESCRIPTION_HANDSHAKE_FAILURE = 13
126 ALERT_DESCRIPTION_ILLEGAL_PARAMETER = 14
127 ALERT_DESCRIPTION_INSUFFICIENT_SECURITY = 15
128 ALERT_DESCRIPTION_INTERNAL_ERROR = 16
129 ALERT_DESCRIPTION_NO_RENEGOTIATION = 17
130 ALERT_DESCRIPTION_PROTOCOL_VERSION = 18
131 ALERT_DESCRIPTION_RECORD_OVERFLOW = 19
132 ALERT_DESCRIPTION_UNEXPECTED_MESSAGE = 20
133 ALERT_DESCRIPTION_UNKNOWN_CA = 21
134 ALERT_DESCRIPTION_UNKNOWN_PSK_IDENTITY = 22
135 ALERT_DESCRIPTION_UNRECOGNIZED_NAME = 23
136 ALERT_DESCRIPTION_UNSUPPORTED_CERTIFICATE = 24
137 ALERT_DESCRIPTION_UNSUPPORTED_EXTENSION = 25
138 ALERT_DESCRIPTION_USER_CANCELLED = 26
140 class SSLErrorNumber(_IntEnum):
141 SSL_ERROR_EOF = 0
142 SSL_ERROR_INVALID_ERROR_CODE = 1
143 SSL_ERROR_SSL = 2
144 SSL_ERROR_SYSCALL = 3
145 SSL_ERROR_WANT_CONNECT = 4
146 SSL_ERROR_WANT_READ = 5
147 SSL_ERROR_WANT_WRITE = 6
148 SSL_ERROR_WANT_X509_LOOKUP = 7
149 SSL_ERROR_ZERO_RETURN = 8
151 class VerifyMode(_IntEnum):
152 CERT_NONE = 0
153 CERT_OPTIONAL = 1
154 CERT_REQUIRED = 2
155 """ + _verifyflags_enum() + _options_enum())
158def register(manager: AstroidManager) -> None:
159 register_module_extender(manager, "ssl", ssl_transform)