Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 1 | # Wrapper module for _ssl, providing some additional facilities |
| 2 | # implemented in Python. Written by Bill Janssen. |
| 3 | |
Guido van Rossum | 5b8b155 | 2007-11-16 00:06:11 +0000 | [diff] [blame] | 4 | """This module provides some more Pythonic support for SSL. |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 5 | |
| 6 | Object types: |
| 7 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 8 | SSLSocket -- subtype of socket.socket which does SSL over the socket |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 9 | |
| 10 | Exceptions: |
| 11 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 12 | SSLError -- exception raised for I/O errors |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 13 | |
| 14 | Functions: |
| 15 | |
| 16 | cert_time_to_seconds -- convert time string used for certificate |
| 17 | notBefore and notAfter functions to integer |
| 18 | seconds past the Epoch (the time values |
| 19 | returned from time.time()) |
| 20 | |
| 21 | fetch_server_certificate (HOST, PORT) -- fetch the certificate provided |
| 22 | by the server running on HOST at port PORT. No |
| 23 | validation of the certificate is performed. |
| 24 | |
| 25 | Integer constants: |
| 26 | |
| 27 | SSL_ERROR_ZERO_RETURN |
| 28 | SSL_ERROR_WANT_READ |
| 29 | SSL_ERROR_WANT_WRITE |
| 30 | SSL_ERROR_WANT_X509_LOOKUP |
| 31 | SSL_ERROR_SYSCALL |
| 32 | SSL_ERROR_SSL |
| 33 | SSL_ERROR_WANT_CONNECT |
| 34 | |
| 35 | SSL_ERROR_EOF |
| 36 | SSL_ERROR_INVALID_ERROR_CODE |
| 37 | |
| 38 | The following group define certificate requirements that one side is |
| 39 | allowing/requiring from the other side: |
| 40 | |
| 41 | CERT_NONE - no certificates from the other side are required (or will |
| 42 | be looked at if provided) |
| 43 | CERT_OPTIONAL - certificates are not required, but if provided will be |
| 44 | validated, and if validation fails, the connection will |
| 45 | also fail |
| 46 | CERT_REQUIRED - certificates are required, and will be validated, and |
| 47 | if validation fails, the connection will also fail |
| 48 | |
| 49 | The following constants identify various SSL protocol variants: |
| 50 | |
| 51 | PROTOCOL_SSLv2 |
| 52 | PROTOCOL_SSLv3 |
| 53 | PROTOCOL_SSLv23 |
| 54 | PROTOCOL_TLSv1 |
| 55 | """ |
| 56 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 57 | import os, sys, textwrap |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 58 | |
| 59 | import _ssl # if we can't import it, let the error propagate |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 60 | |
| 61 | from _ssl import SSLError |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 62 | from _ssl import CERT_NONE, CERT_OPTIONAL, CERT_REQUIRED |
Guido van Rossum | 5b8b155 | 2007-11-16 00:06:11 +0000 | [diff] [blame] | 63 | from _ssl import (PROTOCOL_SSLv2, PROTOCOL_SSLv3, PROTOCOL_SSLv23, |
| 64 | PROTOCOL_TLSv1) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 65 | from _ssl import RAND_status, RAND_egd, RAND_add |
Guido van Rossum | 5b8b155 | 2007-11-16 00:06:11 +0000 | [diff] [blame] | 66 | from _ssl import ( |
| 67 | SSL_ERROR_ZERO_RETURN, |
| 68 | SSL_ERROR_WANT_READ, |
| 69 | SSL_ERROR_WANT_WRITE, |
| 70 | SSL_ERROR_WANT_X509_LOOKUP, |
| 71 | SSL_ERROR_SYSCALL, |
| 72 | SSL_ERROR_SSL, |
| 73 | SSL_ERROR_WANT_CONNECT, |
| 74 | SSL_ERROR_EOF, |
| 75 | SSL_ERROR_INVALID_ERROR_CODE, |
| 76 | ) |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 77 | |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 78 | from socket import socket, AF_INET, SOCK_STREAM, error |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 79 | from socket import getnameinfo as _getnameinfo |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 80 | from socket import error as socket_error |
Guido van Rossum | 39eb8fa | 2007-11-16 01:24:05 +0000 | [diff] [blame] | 81 | from socket import dup as _dup |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 82 | import base64 # for DER-to-PEM translation |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 83 | |
Guido van Rossum | 5b8b155 | 2007-11-16 00:06:11 +0000 | [diff] [blame] | 84 | class SSLSocket(socket): |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 85 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 86 | """This class implements a subtype of socket.socket that wraps |
| 87 | the underlying OS socket in an SSL context when necessary, and |
| 88 | provides read and write methods over that channel.""" |
| 89 | |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 90 | def __init__(self, sock=None, keyfile=None, certfile=None, |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 91 | server_side=False, cert_reqs=CERT_NONE, |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 92 | ssl_version=PROTOCOL_SSLv23, ca_certs=None, |
| 93 | do_handshake_on_connect=True, |
| 94 | family=AF_INET, type=SOCK_STREAM, proto=0, fileno=None, |
| 95 | suppress_ragged_eofs=True): |
| 96 | |
| 97 | self._base = None |
| 98 | |
| 99 | if sock is not None: |
| 100 | # copied this code from socket.accept() |
| 101 | fd = sock.fileno() |
Guido van Rossum | 39eb8fa | 2007-11-16 01:24:05 +0000 | [diff] [blame] | 102 | nfd = _dup(fd) |
| 103 | socket.__init__(self, family=sock.family, type=sock.type, |
| 104 | proto=sock.proto, fileno=nfd) |
| 105 | sock.close() |
| 106 | sock = None |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 107 | elif fileno is not None: |
| 108 | socket.__init__(self, fileno=fileno) |
| 109 | else: |
| 110 | socket.__init__(self, family=family, type=type, proto=proto) |
| 111 | |
| 112 | self._closed = False |
| 113 | |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 114 | if certfile and not keyfile: |
| 115 | keyfile = certfile |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 116 | # see if it's connected |
| 117 | try: |
| 118 | socket.getpeername(self) |
| 119 | except: |
| 120 | # no, no connection yet |
| 121 | self._sslobj = None |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 122 | else: |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 123 | # yes, create the SSL object |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 124 | try: |
| 125 | self._sslobj = _ssl.sslwrap(self, server_side, |
| 126 | keyfile, certfile, |
| 127 | cert_reqs, ssl_version, ca_certs) |
| 128 | if do_handshake_on_connect: |
| 129 | self.do_handshake() |
| 130 | except socket_error as x: |
| 131 | self.close() |
| 132 | raise x |
| 133 | |
| 134 | self._base = sock |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 135 | self.keyfile = keyfile |
| 136 | self.certfile = certfile |
| 137 | self.cert_reqs = cert_reqs |
| 138 | self.ssl_version = ssl_version |
| 139 | self.ca_certs = ca_certs |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 140 | self.do_handshake_on_connect = do_handshake_on_connect |
| 141 | self.suppress_ragged_eofs = suppress_ragged_eofs |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 142 | |
Guido van Rossum | b7b030e | 2007-11-16 01:28:45 +0000 | [diff] [blame^] | 143 | def dup(self): |
| 144 | raise NotImplemented("Can't dup() %s instances" % |
| 145 | self.__class__.__name__) |
| 146 | |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 147 | def _checkClosed(self, msg=None): |
| 148 | # raise an exception here if you wish to check for spurious closes |
| 149 | pass |
| 150 | |
| 151 | def read(self, len=1024, buffer=None): |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 152 | """Read up to LEN bytes and return them. |
| 153 | Return zero-length string on EOF.""" |
| 154 | |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 155 | self._checkClosed() |
| 156 | try: |
| 157 | if buffer: |
| 158 | return self._sslobj.read(buffer, len) |
| 159 | else: |
| 160 | return self._sslobj.read(len) |
| 161 | except SSLError as x: |
| 162 | if x.args[0] == SSL_ERROR_EOF and self.suppress_ragged_eofs: |
| 163 | return b'' |
| 164 | else: |
| 165 | raise |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 166 | |
| 167 | def write(self, data): |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 168 | """Write DATA to the underlying SSL channel. Returns |
| 169 | number of bytes of DATA actually transmitted.""" |
| 170 | |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 171 | self._checkClosed() |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 172 | return self._sslobj.write(data) |
| 173 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 174 | def getpeercert(self, binary_form=False): |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 175 | """Returns a formatted version of the data in the |
| 176 | certificate provided by the other end of the SSL channel. |
| 177 | Return None if no certificate was provided, {} if a |
| 178 | certificate was provided, but not validated.""" |
| 179 | |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 180 | self._checkClosed() |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 181 | return self._sslobj.peer_certificate(binary_form) |
| 182 | |
Guido van Rossum | 5b8b155 | 2007-11-16 00:06:11 +0000 | [diff] [blame] | 183 | def cipher(self): |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 184 | self._checkClosed() |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 185 | if not self._sslobj: |
| 186 | return None |
| 187 | else: |
| 188 | return self._sslobj.cipher() |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 189 | |
Guido van Rossum | 5b8b155 | 2007-11-16 00:06:11 +0000 | [diff] [blame] | 190 | def send(self, data, flags=0): |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 191 | self._checkClosed() |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 192 | if self._sslobj: |
| 193 | if flags != 0: |
| 194 | raise ValueError( |
| 195 | "non-zero flags not allowed in calls to send() on %s" % |
| 196 | self.__class__) |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 197 | while True: |
| 198 | try: |
| 199 | v = self._sslobj.write(data) |
| 200 | except SSLError as x: |
| 201 | if x.args[0] == SSL_ERROR_WANT_READ: |
| 202 | return 0 |
| 203 | elif x.args[0] == SSL_ERROR_WANT_WRITE: |
| 204 | return 0 |
| 205 | else: |
| 206 | raise |
| 207 | else: |
| 208 | return v |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 209 | else: |
| 210 | return socket.send(self, data, flags) |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 211 | |
Guido van Rossum | 5b8b155 | 2007-11-16 00:06:11 +0000 | [diff] [blame] | 212 | def send_to(self, data, addr, flags=0): |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 213 | self._checkClosed() |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 214 | if self._sslobj: |
| 215 | raise ValueError("send_to not allowed on instances of %s" % |
| 216 | self.__class__) |
| 217 | else: |
| 218 | return socket.send_to(self, data, addr, flags) |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 219 | |
Guido van Rossum | 5b8b155 | 2007-11-16 00:06:11 +0000 | [diff] [blame] | 220 | def sendall(self, data, flags=0): |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 221 | self._checkClosed() |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 222 | if self._sslobj: |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 223 | amount = len(data) |
| 224 | count = 0 |
| 225 | while (count < amount): |
| 226 | v = self.send(data[count:]) |
| 227 | count += v |
| 228 | return amount |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 229 | else: |
| 230 | return socket.sendall(self, data, flags) |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 231 | |
Guido van Rossum | 5b8b155 | 2007-11-16 00:06:11 +0000 | [diff] [blame] | 232 | def recv(self, buflen=1024, flags=0): |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 233 | self._checkClosed() |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 234 | if self._sslobj: |
| 235 | if flags != 0: |
| 236 | raise ValueError( |
Guido van Rossum | 5b8b155 | 2007-11-16 00:06:11 +0000 | [diff] [blame] | 237 | "non-zero flags not allowed in calls to recv_into() on %s" % |
| 238 | self.__class__) |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 239 | while True: |
| 240 | try: |
| 241 | return self.read(buflen) |
| 242 | except SSLError as x: |
| 243 | if x.args[0] == SSL_ERROR_WANT_READ: |
| 244 | continue |
| 245 | else: |
| 246 | raise x |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 247 | else: |
| 248 | return socket.recv(self, buflen, flags) |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 249 | |
Guido van Rossum | 5b8b155 | 2007-11-16 00:06:11 +0000 | [diff] [blame] | 250 | def recv_into(self, buffer, nbytes=None, flags=0): |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 251 | self._checkClosed() |
| 252 | if buffer and (nbytes is None): |
| 253 | nbytes = len(buffer) |
| 254 | elif nbytes is None: |
| 255 | nbytes = 1024 |
| 256 | if self._sslobj: |
| 257 | if flags != 0: |
| 258 | raise ValueError( |
Guido van Rossum | 5b8b155 | 2007-11-16 00:06:11 +0000 | [diff] [blame] | 259 | "non-zero flags not allowed in calls to recv_into() on %s" % |
| 260 | self.__class__) |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 261 | while True: |
| 262 | try: |
| 263 | v = self.read(nbytes, buffer) |
| 264 | sys.stdout.flush() |
| 265 | return v |
| 266 | except SSLError as x: |
| 267 | if x.args[0] == SSL_ERROR_WANT_READ: |
| 268 | continue |
| 269 | else: |
| 270 | raise x |
| 271 | else: |
| 272 | return socket.recv_into(self, buffer, nbytes, flags) |
| 273 | |
Guido van Rossum | 5b8b155 | 2007-11-16 00:06:11 +0000 | [diff] [blame] | 274 | def recv_from(self, addr, buflen=1024, flags=0): |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 275 | self._checkClosed() |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 276 | if self._sslobj: |
| 277 | raise ValueError("recv_from not allowed on instances of %s" % |
| 278 | self.__class__) |
| 279 | else: |
| 280 | return socket.recv_from(self, addr, buflen, flags) |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 281 | |
Guido van Rossum | 5b8b155 | 2007-11-16 00:06:11 +0000 | [diff] [blame] | 282 | def pending(self): |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 283 | self._checkClosed() |
| 284 | if self._sslobj: |
| 285 | return self._sslobj.pending() |
| 286 | else: |
| 287 | return 0 |
| 288 | |
Guido van Rossum | 5b8b155 | 2007-11-16 00:06:11 +0000 | [diff] [blame] | 289 | def shutdown(self, how): |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 290 | self._checkClosed() |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 291 | self._sslobj = None |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 292 | socket.shutdown(self, how) |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 293 | |
Guido van Rossum | 5b8b155 | 2007-11-16 00:06:11 +0000 | [diff] [blame] | 294 | def _real_close(self): |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 295 | self._sslobj = None |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 296 | # self._closed = True |
| 297 | if self._base: |
| 298 | self._base.close() |
| 299 | socket._real_close(self) |
| 300 | |
Guido van Rossum | 5b8b155 | 2007-11-16 00:06:11 +0000 | [diff] [blame] | 301 | def do_handshake(self): |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 302 | """Perform a TLS/SSL handshake.""" |
| 303 | |
| 304 | try: |
| 305 | self._sslobj.do_handshake() |
| 306 | except: |
| 307 | self._sslobj = None |
| 308 | raise |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 309 | |
| 310 | def connect(self, addr): |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 311 | """Connects to remote ADDR, and then wraps the connection in |
| 312 | an SSL channel.""" |
| 313 | |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 314 | # Here we assume that the socket is client-side, and not |
| 315 | # connected at the time of the call. We connect it, then wrap it. |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 316 | if self._sslobj: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 317 | raise ValueError("attempt to connect already-connected SSLSocket!") |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 318 | socket.connect(self, addr) |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 319 | self._sslobj = _ssl.sslwrap(self, False, self.keyfile, self.certfile, |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 320 | self.cert_reqs, self.ssl_version, |
| 321 | self.ca_certs) |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 322 | if self.do_handshake_on_connect: |
| 323 | self.do_handshake() |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 324 | |
| 325 | def accept(self): |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 326 | """Accepts a new connection from a remote client, and returns |
| 327 | a tuple containing that new connection wrapped with a server-side |
| 328 | SSL channel, and the address of the remote client.""" |
| 329 | |
| 330 | newsock, addr = socket.accept(self) |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 331 | return (SSLSocket(sock=newsock, |
| 332 | keyfile=self.keyfile, certfile=self.certfile, |
| 333 | server_side=True, |
Guido van Rossum | 5b8b155 | 2007-11-16 00:06:11 +0000 | [diff] [blame] | 334 | cert_reqs=self.cert_reqs, |
| 335 | ssl_version=self.ssl_version, |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 336 | ca_certs=self.ca_certs, |
Guido van Rossum | 5b8b155 | 2007-11-16 00:06:11 +0000 | [diff] [blame] | 337 | do_handshake_on_connect= |
| 338 | self.do_handshake_on_connect), |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 339 | addr) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 340 | |
| 341 | |
| 342 | def wrap_socket(sock, keyfile=None, certfile=None, |
| 343 | server_side=False, cert_reqs=CERT_NONE, |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 344 | ssl_version=PROTOCOL_SSLv23, ca_certs=None, |
| 345 | do_handshake_on_connect=True): |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 346 | |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 347 | return SSLSocket(sock=sock, keyfile=keyfile, certfile=certfile, |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 348 | server_side=server_side, cert_reqs=cert_reqs, |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 349 | ssl_version=ssl_version, ca_certs=ca_certs, |
| 350 | do_handshake_on_connect=do_handshake_on_connect) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 351 | |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 352 | # some utility functions |
| 353 | |
| 354 | def cert_time_to_seconds(cert_time): |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 355 | """Takes a date-time string in standard ASN1_print form |
| 356 | ("MON DAY 24HOUR:MINUTE:SEC YEAR TIMEZONE") and return |
| 357 | a Python time value in seconds past the epoch.""" |
| 358 | |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 359 | import time |
| 360 | return time.mktime(time.strptime(cert_time, "%b %d %H:%M:%S %Y GMT")) |
| 361 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 362 | PEM_HEADER = "-----BEGIN CERTIFICATE-----" |
| 363 | PEM_FOOTER = "-----END CERTIFICATE-----" |
| 364 | |
| 365 | def DER_cert_to_PEM_cert(der_cert_bytes): |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 366 | """Takes a certificate in binary DER format and returns the |
| 367 | PEM version of it as a string.""" |
| 368 | |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 369 | f = str(base64.standard_b64encode(der_cert_bytes), 'ASCII', 'strict') |
| 370 | return (PEM_HEADER + '\n' + |
| 371 | textwrap.fill(f, 64) + '\n' + |
| 372 | PEM_FOOTER + '\n') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 373 | |
| 374 | def PEM_cert_to_DER_cert(pem_cert_string): |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 375 | """Takes a certificate in ASCII PEM format and returns the |
| 376 | DER-encoded version of it as a byte sequence""" |
| 377 | |
| 378 | if not pem_cert_string.startswith(PEM_HEADER): |
| 379 | raise ValueError("Invalid PEM encoding; must start with %s" |
| 380 | % PEM_HEADER) |
| 381 | if not pem_cert_string.strip().endswith(PEM_FOOTER): |
| 382 | raise ValueError("Invalid PEM encoding; must end with %s" |
| 383 | % PEM_FOOTER) |
| 384 | d = pem_cert_string.strip()[len(PEM_HEADER):-len(PEM_FOOTER)] |
Bill Janssen | 6e027db | 2007-11-15 22:23:56 +0000 | [diff] [blame] | 385 | return base64.decodestring(d.encode('ASCII', 'strict')) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 386 | |
Guido van Rossum | 5b8b155 | 2007-11-16 00:06:11 +0000 | [diff] [blame] | 387 | def get_server_certificate(addr, ssl_version=PROTOCOL_SSLv3, ca_certs=None): |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 388 | """Retrieve the certificate from the server at the specified address, |
| 389 | and return it as a PEM-encoded string. |
| 390 | If 'ca_certs' is specified, validate the server cert against it. |
| 391 | If 'ssl_version' is specified, use it in the connection attempt.""" |
| 392 | |
| 393 | host, port = addr |
| 394 | if (ca_certs is not None): |
| 395 | cert_reqs = CERT_REQUIRED |
| 396 | else: |
| 397 | cert_reqs = CERT_NONE |
| 398 | s = wrap_socket(socket(), ssl_version=ssl_version, |
| 399 | cert_reqs=cert_reqs, ca_certs=ca_certs) |
| 400 | s.connect(addr) |
| 401 | dercert = s.getpeercert(True) |
| 402 | s.close() |
| 403 | return DER_cert_to_PEM_cert(dercert) |
| 404 | |
Guido van Rossum | 5b8b155 | 2007-11-16 00:06:11 +0000 | [diff] [blame] | 405 | def get_protocol_name(protocol_code): |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 406 | if protocol_code == PROTOCOL_TLSv1: |
| 407 | return "TLSv1" |
| 408 | elif protocol_code == PROTOCOL_SSLv23: |
| 409 | return "SSLv23" |
| 410 | elif protocol_code == PROTOCOL_SSLv2: |
| 411 | return "SSLv2" |
| 412 | elif protocol_code == PROTOCOL_SSLv3: |
| 413 | return "SSLv3" |
| 414 | else: |
| 415 | return "<unknown>" |