pip._vendor.urllib3.contrib._securetransport.bindings Namespace Reference

Classes
class	CFConst
class	SecurityConst

Functions
	load_cdll (name, macos10_16_path)

Variables
	version = platform.mac_ver()[0]
	version_info = tuple(map(int, version.split(".")))
	Security
	CoreFoundation
	Boolean = c_bool
	CFIndex = c_long
	CFStringEncoding = c_uint32
	CFData = c_void_p
	CFString = c_void_p
	CFArray = c_void_p
	CFMutableArray = c_void_p
	CFDictionary = c_void_p
	CFError = c_void_p
	CFType = c_void_p
	CFTypeID = c_ulong
	CFTypeRef = POINTER(CFType)
	CFAllocatorRef = c_void_p
	OSStatus = c_int32
	CFDataRef = POINTER(CFData)
	CFStringRef = POINTER(CFString)
	CFArrayRef = POINTER(CFArray)
	CFMutableArrayRef = POINTER(CFMutableArray)
	CFDictionaryRef = POINTER(CFDictionary)
	CFArrayCallBacks = c_void_p
	CFDictionaryKeyCallBacks = c_void_p
	CFDictionaryValueCallBacks = c_void_p
	SecCertificateRef = POINTER(c_void_p)
	SecExternalFormat = c_uint32
	SecExternalItemType = c_uint32
	SecIdentityRef = POINTER(c_void_p)
	SecItemImportExportFlags = c_uint32
	SecItemImportExportKeyParameters = c_void_p
	SecKeychainRef = POINTER(c_void_p)
	SSLProtocol = c_uint32
	SSLCipherSuite = c_uint32
	SSLContextRef = POINTER(c_void_p)
	SecTrustRef = POINTER(c_void_p)
	SSLConnectionRef = c_uint32
	SecTrustResultType = c_uint32
	SecTrustOptionFlags = c_uint32
	SSLProtocolSide = c_uint32
	SSLConnectionType = c_uint32
	SSLSessionOption = c_uint32
	argtypes
	restype
	SSLReadFunc = CFUNCTYPE(OSStatus, SSLConnectionRef, c_void_p, POINTER(c_size_t))
	SSLWriteFunc
	argtype
	argstypes
	kSecImportExportPassphrase
	kSecImportItemIdentity
	kCFAllocatorDefault
	kCFTypeArrayCallBacks
	kCFTypeDictionaryKeyCallBacks
	kCFTypeDictionaryValueCallBacks

Detailed Description

This module uses ctypes to bind a whole bunch of functions and constants from
SecureTransport. The goal here is to provide the low-level API to
SecureTransport. These are essentially the C-level functions and constants, and
they're pretty gross to work with.

This code is a bastardised version of the code found in Will Bond's oscrypto
library. An enormous debt is owed to him for blazing this trail for us. For
that reason, this code should be considered to be covered both by urllib3's
license and by oscrypto's:

    Copyright (c) 2015-2016 Will Bond <will@wbond.net>

    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.

Function Documentation

load_cdll()

pip._vendor.urllib3.contrib._securetransport.bindings.load_cdll	(		name,
			macos10_16_path
	)

Loads a CDLL by name, falling back to known path on 10.16+

Variable Documentation

CoreFoundation

pip._vendor.urllib3.contrib._securetransport.bindings.CoreFoundation

Initial value:

=  load_cdll(
    "CoreFoundation",
    "/System/Library/Frameworks/CoreFoundation.framework/CoreFoundation",
)

Security

pip._vendor.urllib3.contrib._securetransport.bindings.Security

Initial value:

=  load_cdll(
    "Security", "/System/Library/Frameworks/Security.framework/Security"
)

SSLWriteFunc

pip._vendor.urllib3.contrib._securetransport.bindings.SSLWriteFunc

Initial value:

=  CFUNCTYPE(
        OSStatus, SSLConnectionRef, POINTER(c_byte), POINTER(c_size_t)
    )