brain_ssl.py 6.4 KB

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