cpython/Modules/_ssl.c at master · python-emscripten/cpython · GitHub

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

/* SSL socket module

SSL support based on patches by Brian E Gallew and Laszlo Kovacs.

Re-worked a bit by Bill Janssen to add server-side support and

certificate decoding. Chris Stawarz contributed some non-blocking

patches.

This module is imported by ssl.py. It should *not* be used

directly.

XXX should partial writes be enabled, SSL_MODE_ENABLE_PARTIAL_WRITE?

XXX integrate several "shutdown modes" as suggested in

http://bugs.python.org/issue8108#msg102867 ?

#define PY_SSIZE_T_CLEAN

#include "Python.h"

/* Redefined below for Windows debug builds after important #includes */

#define _PySSL_FIX_ERRNO

#define PySSL_BEGIN_ALLOW_THREADS_S(save) \

do { if (_ssl_locks_count>0) { (save) = PyEval_SaveThread(); } } while (0)

#define PySSL_END_ALLOW_THREADS_S(save) \

do { if (_ssl_locks_count>0) { PyEval_RestoreThread(save); } _PySSL_FIX_ERRNO; } while (0)

#define PySSL_BEGIN_ALLOW_THREADS { \

PyThreadState *_save = NULL; \

PySSL_BEGIN_ALLOW_THREADS_S(_save);

#define PySSL_BLOCK_THREADS PySSL_END_ALLOW_THREADS_S(_save);

#define PySSL_UNBLOCK_THREADS PySSL_BEGIN_ALLOW_THREADS_S(_save);

#define PySSL_END_ALLOW_THREADS PySSL_END_ALLOW_THREADS_S(_save); }

/* Include symbols from _socket module */

#include "socketmodule.h"

static PySocketModule_APIObject PySocketModule;

#if defined(HAVE_POLL_H)

#include <poll.h>

#elif defined(HAVE_SYS_POLL_H)

#include <sys/poll.h>

#endif

/* Don't warn about deprecated functions */

#ifdef __GNUC__

#pragma GCC diagnostic ignored "-Wdeprecated-declarations"

#endif

#ifdef __clang__

#pragma clang diagnostic ignored "-Wdeprecated-declarations"

#endif

/* Include OpenSSL header files */

#include "openssl/rsa.h"

#include "openssl/crypto.h"

#include "openssl/x509.h"

#include "openssl/x509v3.h"

#include "openssl/pem.h"

#include "openssl/ssl.h"

#include "openssl/err.h"

#include "openssl/rand.h"

#include "openssl/bio.h"

#include "openssl/dh.h"

#ifndef HAVE_X509_VERIFY_PARAM_SET1_HOST

# ifdef LIBRESSL_VERSION_NUMBER

# error "LibreSSL is missing X509_VERIFY_PARAM_set1_host(), see https://github.com/libressl-portable/portable/issues/381"

# elif OPENSSL_VERSION_NUMBER > 0x1000200fL

# define HAVE_X509_VERIFY_PARAM_SET1_HOST

# else

# error "libssl is too old and does not support X509_VERIFY_PARAM_set1_host()"

# endif

#endif

#ifndef OPENSSL_THREADS

# error "OPENSSL_THREADS is not defined, Python requires thread-safe OpenSSL"

#endif

/* SSL error object */

static PyObject *PySSLErrorObject;

static PyObject *PySSLCertVerificationErrorObject;

static PyObject *PySSLZeroReturnErrorObject;

static PyObject *PySSLWantReadErrorObject;

static PyObject *PySSLWantWriteErrorObject;

static PyObject *PySSLSyscallErrorObject;

static PyObject *PySSLEOFErrorObject;

/* Error mappings */

static PyObject *err_codes_to_names;

static PyObject *err_names_to_codes;

static PyObject *lib_codes_to_names;

struct py_ssl_error_code {

const char *mnemonic;

int library, reason;

};

struct py_ssl_library_code {

const char *library;

int code;

};

#if defined(MS_WINDOWS) && defined(Py_DEBUG)

/* Debug builds on Windows rely on getting errno directly from OpenSSL.

* However, because it uses a different CRT, we need to transfer the

* value of errno from OpenSSL into our debug CRT.

* Don't be fooled - this is horribly ugly code. The only reasonable

* alternative is to do both debug and release builds of OpenSSL, which

* requires much uglier code to transform their automatically generated

* makefile. This is the lesser of all the evils.

static void _PySSLFixErrno(void) {

HMODULE ucrtbase = GetModuleHandleW(L"ucrtbase.dll");

if (!ucrtbase) {

/* If ucrtbase.dll is not loaded but the SSL DLLs are, we likely

* have a catastrophic failure, but this function is not the

* place to raise it. */

return;

}

typedef int *(__stdcall *errno_func)(void);

errno_func ssl_errno = (errno_func)GetProcAddress(ucrtbase, "_errno");

if (ssl_errno) {

errno = *ssl_errno();

*ssl_errno() = 0;

} else {

errno = ENOTRECOVERABLE;

}

#undef _PySSL_FIX_ERRNO

#define _PySSL_FIX_ERRNO _PySSLFixErrno()

#endif

/* Include generated data (error codes) */

#include "_ssl_data.h"

#if (OPENSSL_VERSION_NUMBER >= 0x10100000L) && !defined(LIBRESSL_VERSION_NUMBER)

# define OPENSSL_VERSION_1_1 1

# define PY_OPENSSL_1_1_API 1

#endif

/* OpenSSL API compat */

#ifdef OPENSSL_API_COMPAT

#if OPENSSL_API_COMPAT >= 0x10100000L

/* OpenSSL API 1.1.0+ does not include version methods */

#ifndef OPENSSL_NO_TLS1_METHOD

#define OPENSSL_NO_TLS1_METHOD 1

#endif

#ifndef OPENSSL_NO_TLS1_1_METHOD

#define OPENSSL_NO_TLS1_1_METHOD 1

#endif

#ifndef OPENSSL_NO_TLS1_2_METHOD

#define OPENSSL_NO_TLS1_2_METHOD 1

#endif

#endif /* >= 1.1.0 compcat */

#endif /* OPENSSL_API_COMPAT */

/* LibreSSL 2.7.0 provides necessary OpenSSL 1.1.0 APIs */

#if defined(LIBRESSL_VERSION_NUMBER) && LIBRESSL_VERSION_NUMBER >= 0x2070000fL

# define PY_OPENSSL_1_1_API 1

#endif

/* SNI support (client- and server-side) appeared in OpenSSL 1.0.0 and 0.9.8f

* This includes the SSL_set_SSL_CTX() function.

#ifdef SSL_CTRL_SET_TLSEXT_HOSTNAME

# define HAVE_SNI 1

#else

# define HAVE_SNI 0

#endif

#ifdef TLSEXT_TYPE_application_layer_protocol_negotiation

# define HAVE_ALPN 1

#else

# define HAVE_ALPN 0

#endif

/* We cannot rely on OPENSSL_NO_NEXTPROTONEG because LibreSSL 2.6.1 dropped

* NPN support but did not set OPENSSL_NO_NEXTPROTONEG for compatibility

* reasons. The check for TLSEXT_TYPE_next_proto_neg works with

* OpenSSL 1.0.1+ and LibreSSL.

* OpenSSL 1.1.1-pre1 dropped NPN but still has TLSEXT_TYPE_next_proto_neg.

#ifdef OPENSSL_NO_NEXTPROTONEG

# define HAVE_NPN 0

#elif (OPENSSL_VERSION_NUMBER >= 0x10101000L) && !defined(LIBRESSL_VERSION_NUMBER)

# define HAVE_NPN 0

#elif defined(TLSEXT_TYPE_next_proto_neg)

# define HAVE_NPN 1

#else

# define HAVE_NPN 0

#endif

#if (OPENSSL_VERSION_NUMBER >= 0x10101000L) && !defined(LIBRESSL_VERSION_NUMBER)

#define HAVE_OPENSSL_KEYLOG 1

#endif

#ifndef INVALID_SOCKET /* MS defines this */

#define INVALID_SOCKET (-1)

#endif

/* OpenSSL 1.0.2 and LibreSSL needs extra code for locking */

#ifndef OPENSSL_VERSION_1_1

#define HAVE_OPENSSL_CRYPTO_LOCK

#endif

#if defined(OPENSSL_VERSION_1_1) && !defined(OPENSSL_NO_SSL2)

#define OPENSSL_NO_SSL2

#endif

#ifndef PY_OPENSSL_1_1_API

/* OpenSSL 1.1 API shims for OpenSSL < 1.1.0 and LibreSSL < 2.7.0 */

#define TLS_method SSLv23_method

#define TLS_client_method SSLv23_client_method

#define TLS_server_method SSLv23_server_method

#define ASN1_STRING_get0_data ASN1_STRING_data

#define X509_get0_notBefore X509_get_notBefore

#define X509_get0_notAfter X509_get_notAfter

#define OpenSSL_version_num SSLeay

#define OpenSSL_version SSLeay_version

#define OPENSSL_VERSION SSLEAY_VERSION

static int X509_NAME_ENTRY_set(const X509_NAME_ENTRY *ne)

{

return ne->set;

}

#ifndef OPENSSL_NO_COMP

/* LCOV_EXCL_START */

static int COMP_get_type(const COMP_METHOD *meth)

{

return meth->type;

}

/* LCOV_EXCL_STOP */

#endif

static pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)

{

return ctx->default_passwd_callback;

}

static void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)

{

return ctx->default_passwd_callback_userdata;

}

static int X509_OBJECT_get_type(X509_OBJECT *x)

{

return x->type;

}

static X509 *X509_OBJECT_get0_X509(X509_OBJECT *x)

{

return x->data.x509;

}

static int BIO_up_ref(BIO *b)

{

CRYPTO_add(&b->references, 1, CRYPTO_LOCK_BIO);

return 1;

}

static STACK_OF(X509_OBJECT) *X509_STORE_get0_objects(X509_STORE *store) {

return store->objs;

}

static int

SSL_SESSION_has_ticket(const SSL_SESSION *s)

{

return (s->tlsext_ticklen > 0) ? 1 : 0;

}

static unsigned long

SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION *s)

{

return s->tlsext_tick_lifetime_hint;

}

#endif /* OpenSSL < 1.1.0 or LibreSSL < 2.7.0 */

/* Default cipher suites */

#ifndef PY_SSL_DEFAULT_CIPHERS

#define PY_SSL_DEFAULT_CIPHERS 1

#endif

#if PY_SSL_DEFAULT_CIPHERS == 0

#ifndef PY_SSL_DEFAULT_CIPHER_STRING

#error "Py_SSL_DEFAULT_CIPHERS 0 needs Py_SSL_DEFAULT_CIPHER_STRING"

#endif

#elif PY_SSL_DEFAULT_CIPHERS == 1

/* Python custom selection of sensible cipher suites

* DEFAULT: OpenSSL's default cipher list. Since 1.0.2 the list is in sensible order.

* !aNULL:!eNULL: really no NULL ciphers

* !MD5:!3DES:!DES:!RC4:!IDEA:!SEED: no weak or broken algorithms on old OpenSSL versions.

* !aDSS: no authentication with discrete logarithm DSA algorithm

* !SRP:!PSK: no secure remote password or pre-shared key authentication

#define PY_SSL_DEFAULT_CIPHER_STRING "DEFAULT:!aNULL:!eNULL:!MD5:!3DES:!DES:!RC4:!IDEA:!SEED:!aDSS:!SRP:!PSK"

#elif PY_SSL_DEFAULT_CIPHERS == 2

/* Ignored in SSLContext constructor, only used to as _ssl.DEFAULT_CIPHER_STRING */

#define PY_SSL_DEFAULT_CIPHER_STRING SSL_DEFAULT_CIPHER_LIST

#else

#error "Unsupported PY_SSL_DEFAULT_CIPHERS"

#endif

enum py_ssl_error {

/* these mirror ssl.h */

PY_SSL_ERROR_NONE,

PY_SSL_ERROR_SSL,

PY_SSL_ERROR_WANT_READ,

PY_SSL_ERROR_WANT_WRITE,

PY_SSL_ERROR_WANT_X509_LOOKUP,

PY_SSL_ERROR_SYSCALL, /* look at error stack/return value/errno */

PY_SSL_ERROR_ZERO_RETURN,

PY_SSL_ERROR_WANT_CONNECT,

/* start of non ssl.h errorcodes */

PY_SSL_ERROR_EOF, /* special case of SSL_ERROR_SYSCALL */

PY_SSL_ERROR_NO_SOCKET, /* socket has been GC'd */

PY_SSL_ERROR_INVALID_ERROR_CODE

};

enum py_ssl_server_or_client {

PY_SSL_CLIENT,

PY_SSL_SERVER

};

enum py_ssl_cert_requirements {

PY_SSL_CERT_NONE,

PY_SSL_CERT_OPTIONAL,

PY_SSL_CERT_REQUIRED

};

enum py_ssl_version {

PY_SSL_VERSION_SSL2,

PY_SSL_VERSION_SSL3=1,

PY_SSL_VERSION_TLS, /* SSLv23 */

PY_SSL_VERSION_TLS1,

PY_SSL_VERSION_TLS1_1,

PY_SSL_VERSION_TLS1_2,

PY_SSL_VERSION_TLS_CLIENT=0x10,

PY_SSL_VERSION_TLS_SERVER,

};

enum py_proto_version {

PY_PROTO_MINIMUM_SUPPORTED = -2,

PY_PROTO_SSLv3 = SSL3_VERSION,

PY_PROTO_TLSv1 = TLS1_VERSION,

PY_PROTO_TLSv1_1 = TLS1_1_VERSION,

PY_PROTO_TLSv1_2 = TLS1_2_VERSION,

#ifdef TLS1_3_VERSION

PY_PROTO_TLSv1_3 = TLS1_3_VERSION,

#else

PY_PROTO_TLSv1_3 = 0x304,

#endif

PY_PROTO_MAXIMUM_SUPPORTED = -1,

/* OpenSSL has no dedicated API to set the minimum version to the maximum

* available version, and the other way around. We have to figure out the

* minimum and maximum available version on our own and hope for the best.

#if defined(SSL3_VERSION) && !defined(OPENSSL_NO_SSL3)

PY_PROTO_MINIMUM_AVAILABLE = PY_PROTO_SSLv3,

#elif defined(TLS1_VERSION) && !defined(OPENSSL_NO_TLS1)

PY_PROTO_MINIMUM_AVAILABLE = PY_PROTO_TLSv1,

#elif defined(TLS1_1_VERSION) && !defined(OPENSSL_NO_TLS1_1)

PY_PROTO_MINIMUM_AVAILABLE = PY_PROTO_TLSv1_1,

#elif defined(TLS1_2_VERSION) && !defined(OPENSSL_NO_TLS1_2)

PY_PROTO_MINIMUM_AVAILABLE = PY_PROTO_TLSv1_2,

#elif defined(TLS1_3_VERSION) && !defined(OPENSSL_NO_TLS1_3)

PY_PROTO_MINIMUM_AVAILABLE = PY_PROTO_TLSv1_3,

#else

#error "PY_PROTO_MINIMUM_AVAILABLE not found"

#endif

#if defined(TLS1_3_VERSION) && !defined(OPENSSL_NO_TLS1_3)

PY_PROTO_MAXIMUM_AVAILABLE = PY_PROTO_TLSv1_3,

#elif defined(TLS1_2_VERSION) && !defined(OPENSSL_NO_TLS1_2)

PY_PROTO_MAXIMUM_AVAILABLE = PY_PROTO_TLSv1_2,

#elif defined(TLS1_1_VERSION) && !defined(OPENSSL_NO_TLS1_1)

PY_PROTO_MAXIMUM_AVAILABLE = PY_PROTO_TLSv1_1,

#elif defined(TLS1_VERSION) && !defined(OPENSSL_NO_TLS1)

PY_PROTO_MAXIMUM_AVAILABLE = PY_PROTO_TLSv1,

#elif defined(SSL3_VERSION) && !defined(OPENSSL_NO_SSL3)

PY_PROTO_MAXIMUM_AVAILABLE = PY_PROTO_SSLv3,

#else

#error "PY_PROTO_MAXIMUM_AVAILABLE not found"

#endif

};

/* serves as a flag to see whether we've initialized the SSL thread support. */

/* 0 means no, greater than 0 means yes */

static unsigned int _ssl_locks_count = 0;

/* SSL socket object */

#define X509_NAME_MAXLEN 256

/* SSL_CTX_clear_options() and SSL_clear_options() were first added in

* OpenSSL 0.9.8m but do not appear in some 0.9.9-dev versions such the

* 0.9.9 from "May 2008" that NetBSD 5.0 uses. */

#if OPENSSL_VERSION_NUMBER >= 0x009080dfL && OPENSSL_VERSION_NUMBER != 0x00909000L

# define HAVE_SSL_CTX_CLEAR_OPTIONS

#else

# undef HAVE_SSL_CTX_CLEAR_OPTIONS

#endif

/* In case of 'tls-unique' it will be 12 bytes for TLS, 36 bytes for

* older SSL, but let's be safe */

#define PySSL_CB_MAXLEN 128

typedef struct {

PyObject_HEAD

SSL_CTX *ctx;

#if HAVE_NPN

unsigned char *npn_protocols;

int npn_protocols_len;

#endif

#if HAVE_ALPN

unsigned char *alpn_protocols;

unsigned int alpn_protocols_len;

#endif

#ifndef OPENSSL_NO_TLSEXT

PyObject *set_sni_cb;

#endif

int check_hostname;

/* OpenSSL has no API to get hostflags from X509_VERIFY_PARAM* struct.

* We have to maintain our own copy. OpenSSL's hostflags default to 0.

unsigned int hostflags;

int protocol;

#ifdef TLS1_3_VERSION

int post_handshake_auth;

#endif

PyObject *msg_cb;

#ifdef HAVE_OPENSSL_KEYLOG

PyObject *keylog_filename;

BIO *keylog_bio;

#endif

} PySSLContext;

typedef struct {

int ssl; /* last seen error from SSL */

int c; /* last seen error from libc */

#ifdef MS_WINDOWS

int ws; /* last seen error from winsock */

#endif

} _PySSLError;

typedef struct {

PyObject_HEAD

PyObject *Socket; /* weakref to socket on which we're layered */

SSL *ssl;

PySSLContext *ctx; /* weakref to SSL context */

char shutdown_seen_zero;

enum py_ssl_server_or_client socket_type;

PyObject *owner; /* Python level "owner" passed to servername callback */

PyObject *server_hostname;

_PySSLError err; /* last seen error from various sources */

/* Some SSL callbacks don't have error reporting. Callback wrappers

* store exception information on the socket. The handshake, read, write,

* and shutdown methods check for chained exceptions.

PyObject *exc_type;

PyObject *exc_value;

PyObject *exc_tb;

} PySSLSocket;

typedef struct {

PyObject_HEAD

BIO *bio;

int eof_written;

} PySSLMemoryBIO;

typedef struct {

PyObject_HEAD

SSL_SESSION *session;

PySSLContext *ctx;

} PySSLSession;

static PyTypeObject PySSLContext_Type;

static PyTypeObject PySSLSocket_Type;

static PyTypeObject PySSLMemoryBIO_Type;

static PyTypeObject PySSLSession_Type;

static inline _PySSLError _PySSL_errno(int failed, const SSL *ssl, int retcode)

{

_PySSLError err = { 0 };

if (failed) {

#ifdef MS_WINDOWS

err.ws = WSAGetLastError();

_PySSL_FIX_ERRNO;

#endif

err.c = errno;

err.ssl = SSL_get_error(ssl, retcode);

}

return err;

}

/*[clinic input]

module _ssl

class _ssl._SSLContext "PySSLContext *" "&PySSLContext_Type"

class _ssl._SSLSocket "PySSLSocket *" "&PySSLSocket_Type"

class _ssl.MemoryBIO "PySSLMemoryBIO *" "&PySSLMemoryBIO_Type"

class _ssl.SSLSession "PySSLSession *" "&PySSLSession_Type"

[clinic start generated code]*/

/*[clinic end generated code: output=da39a3ee5e6b4b0d input=bdc67fafeeaa8109]*/

#include "clinic/_ssl.c.h"

static int PySSL_select(PySocketSockObject *s, int writing, _PyTime_t timeout);

static int PySSL_set_owner(PySSLSocket *, PyObject *, void *);

static int PySSL_set_session(PySSLSocket *, PyObject *, void *);

#define PySSLSocket_Check(v) Py_IS_TYPE(v, &PySSLSocket_Type)

#define PySSLMemoryBIO_Check(v) Py_IS_TYPE(v, &PySSLMemoryBIO_Type)

#define PySSLSession_Check(v) Py_IS_TYPE(v, &PySSLSession_Type)

typedef enum {

SOCKET_IS_NONBLOCKING,

SOCKET_IS_BLOCKING,

SOCKET_HAS_TIMED_OUT,

SOCKET_HAS_BEEN_CLOSED,

SOCKET_TOO_LARGE_FOR_SELECT,

SOCKET_OPERATION_OK

} timeout_state;

/* Wrap error strings with filename and line # */

#define ERRSTR1(x,y,z) (x ":" y ": " z)

#define ERRSTR(x) ERRSTR1("_ssl.c", Py_STRINGIFY(__LINE__), x)

/* Get the socket from a PySSLSocket, if it has one */

#define GET_SOCKET(obj) ((obj)->Socket ? \

(PySocketSockObject *) PyWeakref_GetObject((obj)->Socket) : NULL)

/* If sock is NULL, use a timeout of 0 second */

#define GET_SOCKET_TIMEOUT(sock) \

((sock != NULL) ? (sock)->sock_timeout : 0)

#include "_ssl/debughelpers.c"

* SSL errors.

PyDoc_STRVAR(SSLError_doc,

"An error occurred in the SSL implementation.");

PyDoc_STRVAR(SSLCertVerificationError_doc,

"A certificate could not be verified.");

PyDoc_STRVAR(SSLZeroReturnError_doc,

"SSL/TLS session closed cleanly.");

PyDoc_STRVAR(SSLWantReadError_doc,

"Non-blocking SSL socket needs to read more data\n"

"before the requested operation can be completed.");

PyDoc_STRVAR(SSLWantWriteError_doc,

"Non-blocking SSL socket needs to write more data\n"

"before the requested operation can be completed.");

PyDoc_STRVAR(SSLSyscallError_doc,

"System error when attempting SSL operation.");

PyDoc_STRVAR(SSLEOFError_doc,

"SSL/TLS connection terminated abruptly.");

static PyObject *

SSLError_str(PyOSErrorObject *self)

{

if (self->strerror != NULL && PyUnicode_Check(self->strerror)) {

Py_INCREF(self->strerror);

return self->strerror;

}

else

return PyObject_Str(self->args);

}

static PyType_Slot sslerror_type_slots[] = {

{Py_tp_base, NULL}, /* Filled out in module init as it's not a constant */

{Py_tp_doc, (void*)SSLError_doc},

{Py_tp_str, SSLError_str},

{0, 0},

};

static PyType_Spec sslerror_type_spec = {

"ssl.SSLError",

sizeof(PyOSErrorObject),

Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,

sslerror_type_slots

};

static void

fill_and_set_sslerror(PySSLSocket *sslsock, PyObject *type, int ssl_errno,

const char *errstr, int lineno, unsigned long errcode)

{

PyObject *err_value = NULL, *reason_obj = NULL, *lib_obj = NULL;

PyObject *verify_obj = NULL, *verify_code_obj = NULL;

PyObject *init_value, *msg, *key;

_Py_IDENTIFIER(reason);

_Py_IDENTIFIER(library);

_Py_IDENTIFIER(verify_message);

_Py_IDENTIFIER(verify_code);

if (errcode != 0) {

int lib, reason;

lib = ERR_GET_LIB(errcode);

reason = ERR_GET_REASON(errcode);

key = Py_BuildValue("ii", lib, reason);

if (key == NULL)

goto fail;

reason_obj = PyDict_GetItemWithError(err_codes_to_names, key);

Py_DECREF(key);

if (reason_obj == NULL && PyErr_Occurred()) {

goto fail;

}

key = PyLong_FromLong(lib);

if (key == NULL)

goto fail;

lib_obj = PyDict_GetItemWithError(lib_codes_to_names, key);

Py_DECREF(key);

if (lib_obj == NULL && PyErr_Occurred()) {

goto fail;

}

if (errstr == NULL)

errstr = ERR_reason_error_string(errcode);

}

if (errstr == NULL)

errstr = "unknown error";

/* verify code for cert validation error */

if ((sslsock != NULL) && (type == PySSLCertVerificationErrorObject)) {

const char *verify_str = NULL;

long verify_code;

verify_code = SSL_get_verify_result(sslsock->ssl);

verify_code_obj = PyLong_FromLong(verify_code);

if (verify_code_obj == NULL) {

goto fail;

}

switch (verify_code) {

#ifdef X509_V_ERR_HOSTNAME_MISMATCH

/* OpenSSL >= 1.0.2, LibreSSL >= 2.5.3 */

case X509_V_ERR_HOSTNAME_MISMATCH:

verify_obj = PyUnicode_FromFormat(

"Hostname mismatch, certificate is not valid for '%S'.",

sslsock->server_hostname

);

break;

#endif

#ifdef X509_V_ERR_IP_ADDRESS_MISMATCH

case X509_V_ERR_IP_ADDRESS_MISMATCH:

verify_obj = PyUnicode_FromFormat(

"IP address mismatch, certificate is not valid for '%S'.",

sslsock->server_hostname

);

break;

#endif

default:

verify_str = X509_verify_cert_error_string(verify_code);

if (verify_str != NULL) {

verify_obj = PyUnicode_FromString(verify_str);

} else {

verify_obj = Py_None;

Py_INCREF(verify_obj);

}

break;

}

if (verify_obj == NULL) {

goto fail;

}

if (verify_obj && reason_obj && lib_obj)

msg = PyUnicode_FromFormat("[%S: %S] %s: %S (_ssl.c:%d)",

lib_obj, reason_obj, errstr, verify_obj,

lineno);

else if (reason_obj && lib_obj)

msg = PyUnicode_FromFormat("[%S: %S] %s (_ssl.c:%d)",

lib_obj, reason_obj, errstr, lineno);

else if (lib_obj)

msg = PyUnicode_FromFormat("[%S] %s (_ssl.c:%d)",

lib_obj, errstr, lineno);

else

msg = PyUnicode_FromFormat("%s (_ssl.c:%d)", errstr, lineno);

if (msg == NULL)

goto fail;

init_value = Py_BuildValue("iN", ERR_GET_REASON(ssl_errno), msg);

if (init_value == NULL)

goto fail;

err_value = PyObject_CallObject(type, init_value);

Py_DECREF(init_value);

if (err_value == NULL)

goto fail;

if (reason_obj == NULL)

reason_obj = Py_None;

if (_PyObject_SetAttrId(err_value, &PyId_reason, reason_obj))

goto fail;

if (lib_obj == NULL)

lib_obj = Py_None;

if (_PyObject_SetAttrId(err_value, &PyId_library, lib_obj))

goto fail;

if ((sslsock != NULL) && (type == PySSLCertVerificationErrorObject)) {

/* Only set verify code / message for SSLCertVerificationError */

if (_PyObject_SetAttrId(err_value, &PyId_verify_code,

verify_code_obj))

goto fail;

if (_PyObject_SetAttrId(err_value, &PyId_verify_message, verify_obj))

goto fail;

}

PyErr_SetObject(type, err_value);

fail:

Py_XDECREF(err_value);

Py_XDECREF(verify_code_obj);

Py_XDECREF(verify_obj);

}

static int

PySSL_ChainExceptions(PySSLSocket *sslsock) {

if (sslsock->exc_type == NULL)

return 0;

_PyErr_ChainExceptions(sslsock->exc_type, sslsock->exc_value, sslsock->exc_tb);

sslsock->exc_type = NULL;

sslsock->exc_value = NULL;

sslsock->exc_tb = NULL;

return -1;

}

static PyObject *

PySSL_SetError(PySSLSocket *sslsock, int ret, const char *filename, int lineno)

{

PyObject *type = PySSLErrorObject;

char *errstr = NULL;

_PySSLError err;

enum py_ssl_error p = PY_SSL_ERROR_NONE;

unsigned long e = 0;

assert(ret <= 0);

e = ERR_peek_last_error();

if (sslsock->ssl != NULL) {

err = sslsock->err;

switch (err.ssl) {

case SSL_ERROR_ZERO_RETURN:

errstr = "TLS/SSL connection has been closed (EOF)";

type = PySSLZeroReturnErrorObject;

p = PY_SSL_ERROR_ZERO_RETURN;

break;

case SSL_ERROR_WANT_READ:

errstr = "The operation did not complete (read)";

type = PySSLWantReadErrorObject;

p = PY_SSL_ERROR_WANT_READ;

break;

case SSL_ERROR_WANT_WRITE:

p = PY_SSL_ERROR_WANT_WRITE;

type = PySSLWantWriteErrorObject;

errstr = "The operation did not complete (write)";

break;

case SSL_ERROR_WANT_X509_LOOKUP:

p = PY_SSL_ERROR_WANT_X509_LOOKUP;

errstr = "The operation did not complete (X509 lookup)";

break;

case SSL_ERROR_WANT_CONNECT:

p = PY_SSL_ERROR_WANT_CONNECT;

errstr = "The operation did not complete (connect)";

break;

case SSL_ERROR_SYSCALL:

{

if (e == 0) {

PySocketSockObject *s = GET_SOCKET(sslsock);

if (ret == 0 || (((PyObject *)s) == Py_None)) {

p = PY_SSL_ERROR_EOF;

type = PySSLEOFErrorObject;

errstr = "EOF occurred in violation of protocol";

} else if (s && ret == -1) {

/* underlying BIO reported an I/O error */

ERR_clear_error();

#ifdef MS_WINDOWS

if (err.ws) {

return PyErr_SetFromWindowsErr(err.ws);

}

#endif

if (err.c) {

errno = err.c;

return PyErr_SetFromErrno(PyExc_OSError);

}

Py_INCREF(s);

s->errorhandler();

Py_DECREF(s);

return NULL;

} else { /* possible? */

p = PY_SSL_ERROR_SYSCALL;

type = PySSLSyscallErrorObject;

errstr = "Some I/O error occurred";

}

} else {

p = PY_SSL_ERROR_SYSCALL;

}

break;

}

case SSL_ERROR_SSL:

{

p = PY_SSL_ERROR_SSL;

if (e == 0) {

/* possible? */

errstr = "A failure in the SSL library occurred";

}

if (ERR_GET_LIB(e) == ERR_LIB_SSL &&

ERR_GET_REASON(e) == SSL_R_CERTIFICATE_VERIFY_FAILED) {

type = PySSLCertVerificationErrorObject;

}

break;

}

default:

p = PY_SSL_ERROR_INVALID_ERROR_CODE;

errstr = "Invalid error code";

}

fill_and_set_sslerror(sslsock, type, p, errstr, lineno, e);

ERR_clear_error();

PySSL_ChainExceptions(sslsock);

return NULL;

}

static PyObject *

_setSSLError (const char *errstr, int errcode, const char *filename, int lineno) {

if (errstr == NULL)

errcode = ERR_peek_last_error();

else

errcode = 0;

fill_and_set_sslerror(NULL, PySSLErrorObject, errcode, errstr, lineno, errcode);

ERR_clear_error();

return NULL;

}

* SSL objects

static int

_ssl_configure_hostname(PySSLSocket *self, const char* server_hostname)

{

int retval = -1;

ASN1_OCTET_STRING *ip;

PyObject *hostname;

size_t len;

assert(server_hostname);

/* Disable OpenSSL's special mode with leading dot in hostname:

* When name starts with a dot (e.g ".example.com"), it will be

* matched by a certificate valid for any sub-domain of name.

len = strlen(server_hostname);

if (len == 0 || *server_hostname == '.') {

PyErr_SetString(

PyExc_ValueError,

"server_hostname cannot be an empty string or start with a "

"leading dot.");

return retval;

}

/* inet_pton is not available on all platforms. */

ip = a2i_IPADDRESS(server_hostname);

if (ip == NULL) {

ERR_clear_error();

}

hostname = PyUnicode_Decode(server_hostname, len, "ascii", "strict");

if (hostname == NULL) {

goto error;

}

self->server_hostname = hostname;

/* Only send SNI extension for non-IP hostnames */

if (ip == NULL) {

if (!SSL_set_tlsext_host_name(self->ssl, server_hostname)) {

_setSSLError(NULL, 0, __FILE__, __LINE__);

}

if (self->ctx->check_hostname) {

X509_VERIFY_PARAM *param = SSL_get0_param(self->ssl);

if (ip == NULL) {

if (!X509_VERIFY_PARAM_set1_host(param, server_hostname,

strlen(server_hostname))) {

_setSSLError(NULL, 0, __FILE__, __LINE__);

goto error;

}

} else {

if (!X509_VERIFY_PARAM_set1_ip(param, ASN1_STRING_get0_data(ip),

ASN1_STRING_length(ip))) {

_setSSLError(NULL, 0, __FILE__, __LINE__);

goto error;

}

retval = 0;

error:

if (ip != NULL) {

ASN1_OCTET_STRING_free(ip);

}

return retval;

}

static PySSLSocket *

newPySSLSocket(PySSLContext *sslctx, PySocketSockObject *sock,

enum py_ssl_server_or_client socket_type,

char *server_hostname,

PyObject *owner, PyObject *session,

PySSLMemoryBIO *inbio, PySSLMemoryBIO *outbio)

{

PySSLSocket *self;

SSL_CTX *ctx = sslctx->ctx;

_PySSLError err = { 0 };

self = PyObject_New(PySSLSocket, &PySSLSocket_Type);

if (self == NULL)

return NULL;

self->ssl = NULL;

self->Socket = NULL;

self->ctx = sslctx;

Py_INCREF(sslctx);

self->shutdown_seen_zero = 0;

self->owner = NULL;

self->server_hostname = NULL;

self->err = err;

self->exc_type = NULL;

self->exc_value = NULL;

self->exc_tb = NULL;

/* Make sure the SSL error state is initialized */

ERR_clear_error();

PySSL_BEGIN_ALLOW_THREADS

self->ssl = SSL_new(ctx);

PySSL_END_ALLOW_THREADS

if (self->ssl == NULL) {

Py_DECREF(self);

_setSSLError(NULL, 0, __FILE__, __LINE__);

return NULL;

}

SSL_set_app_data(self->ssl, self);

if (sock) {

SSL_set_fd(self->ssl, Py_SAFE_DOWNCAST(sock->sock_fd, SOCKET_T, int));

} else {

/* BIOs are reference counted and SSL_set_bio borrows our reference.

* To prevent a double free in memory_bio_dealloc() we need to take an

* extra reference here. */

BIO_up_ref(inbio->bio);

BIO_up_ref(outbio->bio);

SSL_set_bio(self->ssl, inbio->bio, outbio->bio);

}

SSL_set_mode(self->ssl,

SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER | SSL_MODE_AUTO_RETRY);

#ifdef TLS1_3_VERSION

if (sslctx->post_handshake_auth == 1) {

if (socket_type == PY_SSL_SERVER) {

/* bpo-37428: OpenSSL does not ignore SSL_VERIFY_POST_HANDSHAKE.

* Set SSL_VERIFY_POST_HANDSHAKE flag only for server sockets and

* only in combination with SSL_VERIFY_PEER flag. */

int mode = SSL_get_verify_mode(self->ssl);

if (mode & SSL_VERIFY_PEER) {

int (*verify_cb)(int, X509_STORE_CTX *) = NULL;

verify_cb = SSL_get_verify_callback(self->ssl);

mode |= SSL_VERIFY_POST_HANDSHAKE;

SSL_set_verify(self->ssl, mode, verify_cb);

}

} else {

/* client socket */

SSL_set_post_handshake_auth(self->ssl, 1);

}

#endif

if (server_hostname != NULL) {

if (_ssl_configure_hostname(self, server_hostname) < 0) {

View remainder of file in raw view

cpython/Modules/_ssl.c at master · python-emscripten/cpython · GitHub

Navigation Menu

Repository navigation

Expand file tree

Breadcrumbs

_ssl.c

Latest commit

History

Breadcrumbs

_ssl.c

File metadata and controls

Footer

Footer navigation