Ссылка CFHTTPAuthentication

Непрозрачный тип CFHTTPAuthentication обеспечивает абстракцию информации об Аутентификации HTTP.

Функции

Создание Аутентификации HTTP


    
    CFHTTPAuthenticationCreateFromResponse (_: _:)
    CFHTTPAuthenticationCreateFromResponse

Использует ответ ошибки аутентификации для создания объекта CFHTTPAuthentication.

Объявление

Swift

func CFHTTPAuthenticationCreateFromResponse(_ alloc: CFAllocator!, _ response: CFHTTPMessage!) -> Unmanaged<CFHTTPAuthentication>!

Objective C

CFHTTPAuthenticationRef CFHTTPAuthenticationCreateFromResponse ( CFAllocatorRef alloc, CFHTTPMessageRef response );

Параметры

`alloc`	Средство выделения для использования для выделения памяти для нового объекта. Передача `NULL` или `kCFAllocatorDefault` использовать текущее средство выделения по умолчанию.
`response`	Ответ, указывающий ошибку аутентификации; обычно 401 или 407 ответов.

Возвращаемое значение

Объект CFHTTPAuthentication, который может использоваться для добавления учетных данных к будущим запросам. Владение соблюдает Создать Правило.

Обсуждение

Эта функция использует ответ, содержащий информацию об ошибке аутентификации для создания ссылки на объект CFHTTPAuthentication. Можно использовать объект добавить учетные данные к будущим запросам. Можно запросить объект получить следующую информацию:

может ли это использоваться и снова использоваться для аутентификации с его соответствующим сервером [CFHTTPAuthenticationIsValid]
метод аутентификации, который будет использоваться, когда он будет использоваться для выполнения аутентификации [CFHTTPAuthenticationCopyMethod]
связано ли это с определенным CFHTTPMessageRef [CFHTTPAuthenticationAppliesToRequest
будут ли имя пользователя и пароль требоваться, когда это будет использоваться для выполнения аутентификации [CFHTTPAuthenticationRequiresUserNameAndPassword]
будет ли домен учетной записи требоваться, когда он будет использоваться для выполнения аутентификации [CFHTTPAuthenticationRequiresAccountDomain]
должны ли запросы аутентификации быть отправлены по одному в соответствующий сервер [CFHTTPAuthenticationRequiresOrderedRequests]
пространство имен (если таковые имеются), что доменное использование для запроса имя и пароль [CFHTTPAuthenticationCopyRealm]
домен URLs экземпляр применяется к [CFHTTPAuthenticationCopyDomains]

Когда Вы определили, какая информация будет необходима для выполнения аутентификации и накопила ту информацию, вызвать CFHTTPMessageApplyCredentials или CFHTTPMessageApplyCredentialDictionary выполнять аутентификацию.

Оператор импорта

Objective C

@import CFNetwork;

Swift

import CFNetwork

Доступность

Доступный в версии 10.4 OS X и позже.

Функции аутентификации CFHTTP

В этом разделе описываются функции аутентификации CFNetwork, использующиеся для управления информацией аутентификации, связанной с запросом. Функции работают с объектом CFHTTPAuthentication, создающимся из ответа HTTP, переставшего работать с 401 или 407 кодами ошибки.

Когда Вы проанализируете объект CFHTTPAuthentication и получите необходимые учетные данные для выполнения аутентификации, вызвать CFHTTPMessageApplyCredentials или CFHTTPMessageApplyCredentialDictionary выполнять аутентификацию.


    
    CFHTTPAuthenticationAppliesToRequest (_: _:)
    CFHTTPAuthenticationAppliesToRequest

Возвращает булево значение, указывающее, связан ли объект CFHTTPAuthentication с объектом CFHTTPMessage.

Объявление

Swift

func CFHTTPAuthenticationAppliesToRequest(_ auth: CFHTTPAuthentication!, _ request: CFHTTPMessage!) -> Boolean

Objective C

Boolean CFHTTPAuthenticationAppliesToRequest ( CFHTTPAuthenticationRef auth, CFHTTPMessageRef request );

Параметры

`auth`	CFHTTPAuthentication возражают для исследования.
`request`	Запросите это `auth` должен быть протестирован против.

Возвращаемое значение

TRUE если auth связан с request, иначе FALSE.

Обсуждение

Если возвращается эта функция TRUE, можно использовать auth обеспечить информацию аутентификации при использовании request.

Оператор импорта

Objective C

@import CFNetwork;

Swift

import CFNetwork

Доступность

Доступный в OS X v10.2 и позже.

CFHTTPAuthenticationCopyDomains (_:) CFHTTPAuthenticationCopyDomains

Возвращает массив домена URLs, к которому может быть применен данный объект CFHTTPAuthentication.

Объявление

Swift

func CFHTTPAuthenticationCopyDomains(_ auth: CFHTTPAuthentication!) -> Unmanaged<CFArray>!

Objective C

CFArrayRef CFHTTPAuthenticationCopyDomains ( CFHTTPAuthenticationRef auth );

Параметры

auth

CFHTTPAuthentication возражают для исследования.

Возвращаемое значение

Объект CFArray, содержащий домен URL's к который auth должен быть применен. Владение соблюдает Создать Правило.

Обсуждение

Эта функция предоставлена для информационных целей только.

Оператор импорта

Objective C

@import CFNetwork;

Swift

import CFNetwork

Доступность

Доступный в версии 10.4 OS X и позже.
CFHTTPAuthenticationCopyMethod (_:) CFHTTPAuthenticationCopyMethod

Получает самый сильный метод аутентификации, который будет использоваться, когда объект CFHTTPAuthentication будет применен к запросу.

Объявление

Swift

func CFHTTPAuthenticationCopyMethod(_ auth: CFHTTPAuthentication!) -> Unmanaged<CFString>!

Objective C

CFStringRef CFHTTPAuthenticationCopyMethod ( CFHTTPAuthenticationRef auth );

Параметры

auth

CFHTTPAuthentication возражают для исследования.

Возвращаемое значение

Строка, содержащая метод аутентификации, который будет использоваться auth применяется к запросу. Если больше чем один метод аутентификации доступен, самый сильный метод аутентификации возвращается. Владение соблюдает Создать Правило.

Оператор импорта

Objective C

@import CFNetwork;

Swift

import CFNetwork

Доступность

Доступный в версии 10.4 OS X и позже.
CFHTTPAuthenticationCopyRealm (_:) CFHTTPAuthenticationCopyRealm

Получает пространство имен информации аутентификации.

Объявление

Swift

func CFHTTPAuthenticationCopyRealm(_ auth: CFHTTPAuthentication!) -> Unmanaged<CFString>!

Objective C

CFStringRef CFHTTPAuthenticationCopyRealm ( CFHTTPAuthenticationRef auth );

Параметры

auth

CFHTTPAuthentication возражают для исследования.

Возвращаемое значение

Пространство имен, если существует тот; иначе NULL. Владение соблюдает Создать Правило.

Обсуждение

Некоторые методы аутентификации обеспечивают пространство имен, и оно обычно используется для запроса пользователя имя и пароль.

Оператор импорта

Objective C

@import CFNetwork;

Swift

import CFNetwork

Доступность

Доступный в версии 10.4 OS X и позже.


    
    CFHTTPAuthenticationIsValid (_: _:)
    CFHTTPAuthenticationIsValid

Возвращает булево значение, указывающее, допустим ли объект CFHTTPAuthentication.

Объявление

Swift

func CFHTTPAuthenticationIsValid(_ auth: CFHTTPAuthentication!, _ error: UnsafeMutablePointer<CFStreamError>) -> Boolean

Objective C

Boolean CFHTTPAuthenticationIsValid ( CFHTTPAuthenticationRef auth, CFStreamError *error );

Параметры

`auth`	CFHTTPAuthentication возражают для исследования.
`error`	Указатель на a `CFStreamError` структура, чьи поля, если ошибка произошла, установлена в ошибку и домен ошибки.

Возвращаемое значение

TRUE если auth содержит достаточно информации, которая будет применена к запросу.

Если возвращается эта функция FALSE, объект CFHTTPAuthentication может все еще содержать полезную информацию, такую как имя неподдерживаемого метода аутентификации.

Обсуждение

Если возвращается эта функция TRUE для auth, объект хорош для использования с функциями такой как CFHTTPMessageApplyCredentials и CFHTTPMessageApplyCredentialDictionary. Если возвращается эта функция FALSE, auth недопустимо, и аутентификация с помощью него не успешно выполнится.

Оператор импорта

Objective C

@import CFNetwork;

Swift

import CFNetwork

Доступность

Доступный в версии 10.4 OS X и позже.

CFHTTPAuthenticationRequiresAccountDomain (_:) CFHTTPAuthenticationRequiresAccountDomain

Возвращает булево значение, указывающее, использует ли объект CFHTTPAuthentication метод аутентификации, требующий домена учетной записи.

Объявление

Swift

func CFHTTPAuthenticationRequiresAccountDomain(_ auth: CFHTTPAuthentication!) -> Boolean

Objective C

Boolean CFHTTPAuthenticationRequiresAccountDomain ( CFHTTPAuthenticationRef auth );

Параметры

auth

CFHTTPAuthentication возражают для исследования.

Возвращаемое значение

TRUE если auth использует метод аутентификации, требующий домена учетной записи, иначе FALSE.

Оператор импорта

Objective C

@import CFNetwork;

Swift

import CFNetwork

Доступность

Доступный в версии 10.4 OS X и позже.
CFHTTPAuthenticationRequiresOrderedRequests (_:) CFHTTPAuthenticationRequiresOrderedRequests

Возвращает булево значение, указывающее, должны ли запросы аутентификации быть сделаны по одному.

Объявление

Swift

func CFHTTPAuthenticationRequiresOrderedRequests(_ auth: CFHTTPAuthentication!) -> Boolean

Objective C

Boolean CFHTTPAuthenticationRequiresOrderedRequests ( CFHTTPAuthenticationRef auth );

Параметры

auth

CFHTTPAuthentication возражают для исследования.

Возвращаемое значение

TRUE если auth требует упорядоченных запросов, иначе FALSE.

Обсуждение

Некоторые методы аутентификации требуют, чтобы будущие запросы были выполнены упорядоченным способом. Если возвращается эта функция TRUE, клиенты могут улучшить свои возможности аутентификации успешно путем выпуска запросов по одному, когда ответы возвращаются из сервера.

Оператор импорта

Objective C

@import CFNetwork;

Swift

import CFNetwork

Доступность

Доступный в версии 10.4 OS X и позже.
CFHTTPAuthenticationRequiresUserNameAndPassword (_:) CFHTTPAuthenticationRequiresUserNameAndPassword

Возвращает булево значение, указывающее, использует ли объект CFHTTPAuthentication метод аутентификации, требующий имени пользователя и пароля.

Объявление

Swift

func CFHTTPAuthenticationRequiresUserNameAndPassword(_ auth: CFHTTPAuthentication!) -> Boolean

Objective C

Boolean CFHTTPAuthenticationRequiresUserNameAndPassword ( CFHTTPAuthenticationRef auth );

Параметры

auth

CFHTTPAuthentication возражают для исследования.

Возвращаемое значение

TRUE если auth требует имени пользователя и пароля, когда он применяется к запросу; иначе, FALSE.

Оператор импорта

Objective C

@import CFNetwork;

Swift

import CFNetwork

Доступность

Доступный в версии 10.4 OS X и позже.

Получение идентификатора типа CFHTTPAuthentication

CFHTTPAuthenticationGetTypeID () CFHTTPAuthenticationGetTypeID

Получает Базовый идентификатор типа Основы для непрозрачного типа CFHTTPAuthentication.

Объявление

Swift

func CFHTTPAuthenticationGetTypeID() -> CFTypeID

Objective C

CFTypeID CFHTTPAuthenticationGetTypeID ( void );

Возвращаемое значение

Базовый идентификатор типа Основы для непрозрачного типа CFHTTPAuthentication.

Оператор импорта

Objective C

@import CFNetwork;

Swift

import CFNetwork

Доступность

Доступный в версии 10.4 OS X и позже.

Типы данных

CFHTTPAuthenticationRef

Непрозрачная ссылка, представляющая информацию об Аутентификации HTTP.

Объявление

Swift

typealias CFHTTPAuthenticationRef = CFHTTPAuthentication

Objective C

typedef struct __CFHTTPAuthentication *CFHTTPAuthenticationRef;

Доступность

Доступный в версии 10.4 OS X и позже.

Константы

Константы схемы аутентификации CFHTTP
Указывает схему аутентификации при добавлении, что информация аутентификации к CFHTTP запрашивает объект сообщения.

Объявление

Swift

let kCFHTTPAuthenticationSchemeBasic: CFString! let kCFHTTPAuthenticationSchemeDigest: CFString! let kCFHTTPAuthenticationSchemeNegotiate: CFString! let kCFHTTPAuthenticationSchemeNTLM: CFString!

Objective C

const CFStringRef kCFHTTPAuthenticationSchemeBasic; const CFStringRef kCFHTTPAuthenticationSchemeDigest; const CFStringRef kCFHTTPAuthenticationSchemeNegotiate; const CFStringRef kCFHTTPAuthenticationSchemeNTLM;

Константы
- kCFHTTPAuthenticationSchemeBasic
  
  kCFHTTPAuthenticationSchemeBasic
  
  Указывает стандартную аутентификацию, состоящую из имени пользователя и пароля.
  
  Доступный в OS X v10.2 и позже.
- kCFHTTPAuthenticationSchemeDigest
  
  kCFHTTPAuthenticationSchemeDigest
  
  Зарезервированный.
  
  Доступный в OS X v10.2 и позже.
- kCFHTTPAuthenticationSchemeNegotiate
  
  kCFHTTPAuthenticationSchemeNegotiate
  
  Указывает Согласовывать схему аутентификации.
  
  Доступный в OS X v10.5 и позже.
- kCFHTTPAuthenticationSchemeNTLM
  
  kCFHTTPAuthenticationSchemeNTLM
  
  Указывает схему аутентификации NTLM.
  
  Доступный в OS X v10.5 и позже.
Обсуждение

Константы схемы аутентификации используются для указания схемы аутентификации при вызове CFHTTPMessageAddAuthentication.
Ошибочные константы аутентификации HTTP CFStream
Коды ошибки аутентификации, которые могут быть возвращены при попытке применить аутентификацию к запросу.

Объявление

Swift

enum CFStreamErrorHTTPAuthentication : Int32 { case TypeUnsupported case BadUserName case BadPassword }

Objective C

enum CFStreamErrorHTTPAuthentication { kCFStreamErrorHTTPAuthenticationTypeUnsupported = -1000, kCFStreamErrorHTTPAuthenticationBadUserName = -1001, kCFStreamErrorHTTPAuthenticationBadPassword = -1002 }; typedef enum CFStreamErrorHTTPAuthentication CFStreamErrorHTTPAuthentication;

Константы
- TypeUnsupported
  
  kCFStreamErrorHTTPAuthenticationTypeUnsupported
  
  Указанный тип аутентификации не поддерживается.
  
  Доступный в OS X v10.4 и позже.
- BadUserName
  
  kCFStreamErrorHTTPAuthenticationBadUserName
  
  Имя пользователя находится в формате, не подходящем для запроса. В настоящее время имена пользователей декодируются с помощью kCFStringEncodingISOLatin1.
  
  Доступный в OS X v10.4 и позже.
- BadPassword
  
  kCFStreamErrorHTTPAuthenticationBadPassword
  
  Пароль находится в формате, не подходящем для запроса. В настоящее время пароли декодируются с помощью kCFStringEncodingISOLatin1.
  
  Доступный в OS X v10.4 и позже.
Оператор импорта

Objective C

@import CFNetwork;

Swift

import CFNetwork

Доступность

Доступный в OS X v10.4 и позже.
Ключи CFHTTPMessageApplyCredentialDictionary
Константы для ключей в словаре передали CFHTTPMessageApplyCredentialDictionary.

Объявление

Swift

let kCFHTTPAuthenticationUsername: CFString! let kCFHTTPAuthenticationPassword: CFString! let kCFHTTPAuthenticationAccountDomain: CFString!

Objective C

const CFStringRef kCFHTTPAuthenticationUsername; const CFStringRef kCFHTTPAuthenticationPassword; const CFStringRef kCFHTTPAuthenticationAccountDomain;

Константы
- kCFHTTPAuthenticationUsername
  
  kCFHTTPAuthenticationUsername
  
  Имя пользователя для использования для аутентификации.
  
  Доступный в OS X v10.4 и позже.
- kCFHTTPAuthenticationPassword
  
  kCFHTTPAuthenticationPassword
  
  Пароль для использования для аутентификации.
  
  Доступный в OS X v10.4 и позже.
- kCFHTTPAuthenticationAccountDomain
  
  kCFHTTPAuthenticationAccountDomain
  
  Считайте домен для использования для аутентификации.
  
  Доступный в OS X v10.4 и позже.