From d5938ee76c0c8abdf7eded0af2a6a2c3f269117a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Val=C3=A9rian=20Rousset?= Date: Mon, 18 Jul 2016 04:27:29 +0200 Subject: [PATCH] Add cpython specific constants to ssl (#291) * Revert "Revert "add types to ssl for py2 (#251)"" This reverts commit 0b19fb471c45af762a0999a2d6ee8de70414acce (thus re-adding types to ssl). * add some undocumented ssl constants --- stdlib/2.7/ssl.pyi | 331 ++++++++++++++++++++++++--------------------- stdlib/3/ssl.pyi | 22 +++ 2 files changed, 196 insertions(+), 157 deletions(-) diff --git a/stdlib/2.7/ssl.pyi b/stdlib/2.7/ssl.pyi index 103fc45cc..abbba9b54 100644 --- a/stdlib/2.7/ssl.pyi +++ b/stdlib/2.7/ssl.pyi @@ -1,190 +1,207 @@ -# Stubs for ssl (Python 2) +# Stubs for ssl -from typing import Any -from socket import socket, error as socket_error -from collections import namedtuple +from typing import ( + Any, Dict, Callable, List, NamedTuple, Optional, Set, Tuple, Union, +) +import socket +import sys -class SSLError(OSError): ... -class SSLEOFError(SSLError): ... -class SSLSyscallError(SSLError): ... +_PCTRTT = Tuple[Tuple[str, str], ...] +_PCTRTTT = Tuple[_PCTRTT, ...] +_PeerCertRetDictType = Dict[str, Union[str, _PCTRTTT, _PCTRTT]] +_PeerCertRetType = Union[_PeerCertRetDictType, bytes, None] +_EnumRetType = List[Tuple[bytes, str, Union[Set[str], bool]]] +_PasswordType = Union[Callable[[], Union[str, bytes]], str, bytes] +_SrvnmeCbType = Callable[['SSLSocket', Optional[str], 'SSLSocket'], Optional[int]] + +class SSLError(OSError): + library = ... # type: str + reason = ... # type: str +class SSLZeroReturnError(SSLError): ... class SSLWantReadError(SSLError): ... class SSLWantWriteError(SSLError): ... -class SSLZeroReturnError(SSLError): ... +class SSLSyscallError(SSLError): ... +class SSLEOFError(SSLError): ... +class CertificateError(Exception): ... -OPENSSL_VERSION = ... # type: str -OPENSSL_VERSION_INFO = ... # type: Any -OPENSSL_VERSION_NUMBER = ... # type: int -VERIFY_CRL_CHECK_CHAIN = ... # type: int -VERIFY_CRL_CHECK_LEAF = ... # type: int -VERIFY_DEFAULT = ... # type: int -VERIFY_X509_STRICT = ... # type: int +def wrap_socket(sock: socket.socket, keyfile: Optional[str] = ..., + certfile: Optional[str] = ..., server_side: bool = ..., + cert_reqs: int = ..., ssl_version: int = ..., + ca_certs: Optional[str] = ..., + do_handshake_on_connect: bool = ..., + suppress_ragged_eofs: bool = ..., + ciphers: Optional[str] = ...) -> 'SSLSocket': ... -ALERT_DESCRIPTION_ACCESS_DENIED = ... # type: int -ALERT_DESCRIPTION_BAD_CERTIFICATE = ... # type: int -ALERT_DESCRIPTION_BAD_CERTIFICATE_HASH_VALUE = ... # type: int -ALERT_DESCRIPTION_BAD_CERTIFICATE_STATUS_RESPONSE = ... # type: int -ALERT_DESCRIPTION_BAD_RECORD_MAC = ... # type: int -ALERT_DESCRIPTION_CERTIFICATE_EXPIRED = ... # type: int -ALERT_DESCRIPTION_CERTIFICATE_REVOKED = ... # type: int -ALERT_DESCRIPTION_CERTIFICATE_UNKNOWN = ... # type: int -ALERT_DESCRIPTION_CERTIFICATE_UNOBTAINABLE = ... # type: int -ALERT_DESCRIPTION_CLOSE_NOTIFY = ... # type: int -ALERT_DESCRIPTION_DECODE_ERROR = ... # type: int -ALERT_DESCRIPTION_DECOMPRESSION_FAILURE = ... # type: int -ALERT_DESCRIPTION_DECRYPT_ERROR = ... # type: int -ALERT_DESCRIPTION_HANDSHAKE_FAILURE = ... # type: int -ALERT_DESCRIPTION_ILLEGAL_PARAMETER = ... # type: int -ALERT_DESCRIPTION_INSUFFICIENT_SECURITY = ... # type: int -ALERT_DESCRIPTION_INTERNAL_ERROR = ... # type: int -ALERT_DESCRIPTION_NO_RENEGOTIATION = ... # type: int -ALERT_DESCRIPTION_PROTOCOL_VERSION = ... # type: int -ALERT_DESCRIPTION_RECORD_OVERFLOW = ... # type: int -ALERT_DESCRIPTION_UNEXPECTED_MESSAGE = ... # type: int -ALERT_DESCRIPTION_UNKNOWN_CA = ... # type: int -ALERT_DESCRIPTION_UNKNOWN_PSK_IDENTITY = ... # type: int -ALERT_DESCRIPTION_UNRECOGNIZED_NAME = ... # type: int -ALERT_DESCRIPTION_UNSUPPORTED_CERTIFICATE = ... # type: int -ALERT_DESCRIPTION_UNSUPPORTED_EXTENSION = ... # type: int -ALERT_DESCRIPTION_USER_CANCELLED = ... # type: int -OP_ALL = ... # type: int -OP_CIPHER_SERVER_PREFERENCE = ... # type: int -OP_NO_COMPRESSION = ... # type: int -OP_NO_SSLv2 = ... # type: int -OP_NO_SSLv3 = ... # type: int -OP_NO_TLSv1 = ... # type: int -OP_NO_TLSv1_1 = ... # type: int -OP_NO_TLSv1_2 = ... # type: int -OP_SINGLE_DH_USE = ... # type: int -OP_SINGLE_ECDH_USE = ... # type: int +def create_default_context(purpose: Any = ..., *, + cafile: Optional[str] = ..., + capath: Optional[str] = ..., + cadata: Optional[str] = ...) -> 'SSLContext': ... + + +def RAND_status() -> bool: ... +def RAND_egd(path: str) -> None: ... +def RAND_add(bytes: bytes, entropy: float) -> None: ... + + +def match_hostname(cert: _PeerCertRetType, hostname: str) -> None: ... +def cert_time_to_seconds(cert_time: str) -> int: ... +def get_server_certificate(addr: Tuple[str, int], ssl_version: int = ..., + ca_certs: Optional[str] = ...) -> str: ... +def DER_cert_to_PEM_cert(der_cert_bytes: bytes) -> str: ... +def PEM_cert_to_DER_cert(pem_cert_string: str) -> bytes: ... +DefaultVerifyPaths = NamedTuple('DefaultVerifyPaths', + [('cafile', str), ('capath', str), + ('openssl_cafile_env', str), + ('openssl_cafile', str), + ('openssl_capath_env', str), + ('openssl_capath', str)]) +def get_default_verify_paths() -> DefaultVerifyPaths: ... + +if sys.platform == 'win32': + def enum_certificates(store_name: str) -> _EnumRetType: ... + def enum_crls(store_name: str) -> _EnumRetType: ... -SSL_ERROR_EOF = ... # type: int -SSL_ERROR_INVALID_ERROR_CODE = ... # type: int -SSL_ERROR_SSL = ... # type: int -SSL_ERROR_SYSCALL = ... # type: int -SSL_ERROR_WANT_CONNECT = ... # type: int -SSL_ERROR_WANT_READ = ... # type: int -SSL_ERROR_WANT_WRITE = ... # type: int -SSL_ERROR_WANT_X509_LOOKUP = ... # type: int -SSL_ERROR_ZERO_RETURN = ... # type: int CERT_NONE = ... # type: int CERT_OPTIONAL = ... # type: int CERT_REQUIRED = ... # type: int +VERIFY_DEFAULT = ... # type: int +VERIFY_CRL_CHECK_LEAF = ... # type: int +VERIFY_CRL_CHECK_CHAIN = ... # type: int +VERIFY_X509_STRICT = ... # type: int +VERIFY_X509_TRUSTED_FIRST = ... # type: int + PROTOCOL_SSLv23 = ... # type: int +PROTOCOL_SSLv2 = ... # type: int PROTOCOL_SSLv3 = ... # type: int PROTOCOL_TLSv1 = ... # type: int PROTOCOL_TLSv1_1 = ... # type: int PROTOCOL_TLSv1_2 = ... # type: int +OP_ALL = ... # type: int +OP_NO_SSLv2 = ... # type: int +OP_NO_SSLv3 = ... # type: int +OP_NO_TLSv1 = ... # type: int +OP_NO_TLSv1_1 = ... # type: int +OP_NO_TLSv1_2 = ... # type: int +OP_CIPHER_SERVER_PREFERENCE = ... # type: int +OP_SINGLE_DH_USE = ... # type: int +OP_SINGLE_ECDH_USE = ... # type: int +OP_NO_COMPRESSION = ... # type: int + +HAS_ALPN = ... # type: int HAS_ECDH = ... # type: bool -HAS_NPN = ... # type: bool HAS_SNI = ... # type: bool +HAS_NPN = ... # type: bool +CHANNEL_BINDING_TYPES = ... # type: List[str] -CHANNEL_BINDING_TYPES = ... # type: Any +OPENSSL_VERSION = ... # type: str +OPENSSL_VERSION_INFO = ... # type: Tuple[int, int, int, int, int] +OPENSSL_VERSION_NUMBER = ... # type: int -class CertificateError(ValueError): ... +ALERT_DESCRIPTION_HANDSHAKE_FAILURE = ... # type: int +ALERT_DESCRIPTION_INTERNAL_ERROR = ... # type: int +ALERT_DESCRIPTION_ACCESS_DENIED = ... # type: int +ALERT_DESCRIPTION_BAD_CERTIFICATE = ... # type: int +ALERT_DESCRIPTION_BAD_CERTIFICATE_HASH_VALUE = ... # type: int +ALERT_DESCRIPTION_BAD_CERTIFICATE_STATUS_RESPONSE = ... # type: int +ALERT_DESCRIPTION_BAD_RECORD_MAC = ... # type: int +ALERT_DESCRIPTION_CERTIFICATE_EXPIRED = ... # type: int +ALERT_DESCRIPTION_CERTIFICATE_REVOKED = ... # type: int +ALERT_DESCRIPTION_CERTIFICATE_UNKNOWN = ... # type: int +ALERT_DESCRIPTION_CERTIFICATE_UNOBTAINABLE = ... # type: int +ALERT_DESCRIPTION_CLOSE_NOTIFY = ... # type: int +ALERT_DESCRIPTION_DECODE_ERROR = ... # type: int +ALERT_DESCRIPTION_DECOMPRESSION_FAILURE = ... # type: int +ALERT_DESCRIPTION_DECRYPT_ERROR = ... # type: int +ALERT_DESCRIPTION_ILLEGAL_PARAMETER = ... # type: int +ALERT_DESCRIPTION_INSUFFICIENT_SECURITY = ... # type: int +ALERT_DESCRIPTION_NO_RENEGOTIATION = ... # type: int +ALERT_DESCRIPTION_PROTOCOL_VERSION = ... # type: int +ALERT_DESCRIPTION_RECORD_OVERFLOW = ... # type: int +ALERT_DESCRIPTION_UNEXPECTED_MESSAGE = ... # type: int +ALERT_DESCRIPTION_UNKNOWN_CA = ... # type: int +ALERT_DESCRIPTION_UNKNOWN_PSK_IDENTITY = ... # type: int +ALERT_DESCRIPTION_UNRECOGNIZED_NAME = ... # type: int +ALERT_DESCRIPTION_UNSUPPORTED_CERTIFICATE = ... # type: int +ALERT_DESCRIPTION_UNSUPPORTED_EXTENSION = ... # type: int +ALERT_DESCRIPTION_USER_CANCELLED = ... # type: int -def match_hostname(cert, hostname): ... +_PurposeType = NamedTuple('_PurposeType', + [('nid', int), ('shortname', str), + ('longname', str), ('oid', str)]) +class Purpose: + SERVER_AUTH = ... # type: _PurposeType + CLIENT_AUTH = ... # type: _PurposeType -DefaultVerifyPaths = namedtuple('DefaultVerifyPaths', 'cafile capath openssl_cafile_env openssl_cafile openssl_capath_env openssl_capath') -def get_default_verify_paths(): ... +class SSLSocket(socket.socket): + def do_handshake(self) -> None: ... + def getpeercert(self, binary_form: bool = ...) -> _PeerCertRetType: ... + def cipher(self) -> Tuple[str, int, int]: ... + def compression(self) -> Optional[str]: ... + def get_channel_binding(self, cb_type: str = ...) -> Optional[bytes]: ... + def selected_alpn_protocol(self) -> Optional[str]: ... + def selected_npn_protocol(self) -> Optional[str]: ... + def unwrap(self) -> socket.socket: ... + def version(self) -> Optional[str]: ... -class _ASN1Object: - def __new__(cls, oid): ... - @classmethod - def fromnid(cls, nid): ... - @classmethod - def fromname(cls, name): ... -class Purpose(_ASN1Object): - SERVER_AUTH = ... # type: Purpose - CLIENT_AUTH = ... # type: Purpose - -class _SSLContext: - check_hostname = ... # type: Any - options = ... # type: Any - verify_flags = ... # type: Any - verify_mode = ... # type: Any - def __init__(self, *args, **kwargs) -> None: ... - def _set_npn_protocols(self, *args, **kwargs): ... - def _wrap_socket(self, *args, **kwargs): ... - def cert_store_stats(self): ... - def get_ca_certs(self, binary_form=...): ... - def load_cert_chain(self, *args, **kwargs): ... - def load_dh_params(self, *args, **kwargs): ... - def load_verify_locations(self, *args, **kwargs): ... - def session_stats(self, *args, **kwargs): ... - def set_ciphers(self, *args, **kwargs): ... - def set_default_verify_paths(self, *args, **kwargs): ... - def set_ecdh_curve(self, *args, **kwargs): ... - def set_servername_callback(self, method): ... - -class SSLContext(_SSLContext): - def __new__(cls, protocol, *args, **kwargs): ... - protocol = ... # type: Any - def __init__(self, protocol): ... - def wrap_socket(self, sock, server_side=False, do_handshake_on_connect=True, suppress_ragged_eofs=True, server_hostname=None): ... - def set_npn_protocols(self, npn_protocols): ... - def set_alpn_protocols(self, alpn_protocols): ... - def load_default_certs(self, purpose=...): ... - -def create_default_context(purpose=..., cafile=None, capath=None, cadata=None): ... - -class SSLSocket(socket): - keyfile = ... # type: Any - certfile = ... # type: Any - cert_reqs = ... # type: Any - ssl_version = ... # type: Any - ca_certs = ... # type: Any - ciphers = ... # type: Any - server_side = ... # type: Any - server_hostname = ... # type: Any - do_handshake_on_connect = ... # type: Any - suppress_ragged_eofs = ... # type: Any - def __init__(self, sock=None, keyfile=None, certfile=None, server_side=False, cert_reqs=..., ssl_version=..., ca_certs=None, do_handshake_on_connect=True, family=..., type=..., proto=0, fileno=None, suppress_ragged_eofs=True, npn_protocols=None, ciphers=None, server_hostname=None, _context=None): ... +class SSLContext: + check_hostname = ... # type: bool + options = ... # type: int @property - def context(self): ... - @context.setter - def context(self, ctx): ... - def dup(self): ... - def read(self, len=0, buffer=None): ... - def write(self, data): ... - def getpeercert(self, binary_form=False): ... - def selected_npn_protocol(self): ... - def selected_alpn_protocol(self): ... - def cipher(self): ... - def compression(self): ... - def send(self, data, flags=0): ... - def sendto(self, data, flags_or_addr, addr=None): ... - def sendall(self, data, flags=0): ... - def recv(self, buflen=1024, flags=0): ... - def recv_into(self, buffer, nbytes=None, flags=0): ... - def recvfrom(self, buflen=1024, flags=0): ... - def recvfrom_into(self, buffer, nbytes=None, flags=0): ... - def pending(self): ... - def shutdown(self, how): ... - def close(self): ... - def unwrap(self): ... - def do_handshake(self, block=False): ... - def connect(self, addr): ... - def connect_ex(self, addr): ... - def accept(self): ... - def makefile(self, mode='', bufsize=-1): ... - def get_channel_binding(self, cb_type=''): ... - def version(self): ... + def protocol(self) -> int: ... + verify_flags = ... # type: int + verify_mode = ... # type: int + def __init__(self, protocol: int) -> None: ... + def cert_store_stats(self) -> Dict[str, int]: ... + def load_cert_chain(self, certfile: str, keyfile: Optional[str] = ..., + password: _PasswordType = ...) -> None: ... + def load_default_certs(self, purpose: _PurposeType = ...) -> None: ... + def load_verify_locations(self, cafile: Optional[str] = ..., + capath: Optional[str] = ..., + cadata: Union[str, bytes, None] = ...) \ + -> None: ... + def get_ca_certs(self, + binary_form: bool = ...) \ + -> Union[List[_PeerCertRetDictType], List[bytes]]: ... + def set_default_verify_paths(self) -> None: ... + def set_ciphers(self, ciphers: str) -> None: ... + def set_alpn_protocols(protocols: List[str]) -> None: ... + def set_npn_protocols(protocols: List[str]) -> None: ... + def set_servername_callback(self, + server_name_callback: Optional[_SrvnmeCbType]) \ + -> None: ... + def load_dh_params(self, dhfile: str) -> None: ... + def set_ecdh_curve(self, curve_name: str) -> None: ... + def wrap_socket(self, sock: socket.socket, server_side: bool = ..., + do_handshake_on_connect: bool = ..., + suppress_ragged_eofs: bool = ..., + server_hostname: Optional[str] = ...) -> 'SSLContext': ... + def session_stats(self) -> Dict[str, int]: ... -def wrap_socket(sock, keyfile=None, certfile=None, server_side=False, cert_reqs=..., ssl_version=..., ca_certs=None, do_handshake_on_connect=True, suppress_ragged_eofs=True, ciphers=None): ... -def cert_time_to_seconds(cert_time): ... -PEM_HEADER = ... # type: Any -PEM_FOOTER = ... # type: Any +# TODO below documented in cpython but not in docs.python.org +# taken from python 3.4 +SSL_ERROR_EOF = ... # type: int +SSL_ERROR_INVALID_ERROR_CODE = ... # type: int +SSL_ERROR_SSL = ... # type: int +SSL_ERROR_SYSCALL = ... # type: int +SSL_ERROR_WANT_CONNECT = ... # type: int +SSL_ERROR_WANT_READ = ... # type: int +SSL_ERROR_WANT_WRITE = ... # type: int +SSL_ERROR_WANT_X509_LOOKUP = ... # type: int +SSL_ERROR_ZERO_RETURN = ... # type: int -def DER_cert_to_PEM_cert(der_cert_bytes): ... -def PEM_cert_to_DER_cert(pem_cert_string): ... -def get_server_certificate(addr, ssl_version=..., ca_certs=None): ... -def get_protocol_name(protocol_code): ... -def sslwrap_simple(sock, keyfile=None, certfile=None): ... +def get_protocol_name(protocol_code: int) -> str: ... + +AF_INET = ... # type: int +PEM_FOOTER = ... # type: str +PEM_HEADER = ... # type: str +SOCK_STREAM = ... # type: int +SOL_SOCKET = ... # type: int +SO_TYPE = ... # type: int diff --git a/stdlib/3/ssl.pyi b/stdlib/3/ssl.pyi index cee097838..8a006d61d 100644 --- a/stdlib/3/ssl.pyi +++ b/stdlib/3/ssl.pyi @@ -250,3 +250,25 @@ if sys.version_info >= (3, 5): def read(self, n: int = ...) -> bytes: ... def write(self, buf: bytes) -> int: ... def write_eof(self) -> None: ... + + +# TODO below documented in cpython but not in docs.python.org +# taken from python 3.4 +SSL_ERROR_EOF = ... # type: int +SSL_ERROR_INVALID_ERROR_CODE = ... # type: int +SSL_ERROR_SSL = ... # type: int +SSL_ERROR_SYSCALL = ... # type: int +SSL_ERROR_WANT_CONNECT = ... # type: int +SSL_ERROR_WANT_READ = ... # type: int +SSL_ERROR_WANT_WRITE = ... # type: int +SSL_ERROR_WANT_X509_LOOKUP = ... # type: int +SSL_ERROR_ZERO_RETURN = ... # type: int + +def get_protocol_name(protocol_code: int) -> str: ... + +AF_INET = ... # type: int +PEM_FOOTER = ... # type: str +PEM_HEADER = ... # type: str +SOCK_STREAM = ... # type: int +SOL_SOCKET = ... # type: int +SO_TYPE = ... # type: int