Function

SecKeychainFindInternetPassword

Finds the first Internet password based on the attributes passed.

Declaration

OSStatus SecKeychainFindInternetPassword(CFTypeRef keychainOrArray, UInt32 serverNameLength, const char *serverName, UInt32 securityDomainLength, const char *securityDomain, UInt32 accountNameLength, const char *accountName, UInt32 pathLength, const char *path, UInt16 port, SecProtocolType protocol, SecAuthenticationType authenticationType, UInt32 *passwordLength, void * _Nullable *passwordData, SecKeychainItemRef  _Nullable *itemRef);

Parameters

keychainOrArray

A reference to an array of keychains to search, a single keychain or NULL to search the user’s default keychain search list.

serverNameLength

The length of the serverName character string.

serverName

A UTF-8 encoded character string representing the server name.

securityDomainLength

The length of the securityDomain character string.

securityDomain

A UTF-8 encoded character string representing the security domain. This parameter is optional, as not all protocols require it. Pass NULL if it is not required.

accountNameLength

The length of the accountName character string.

accountName

A UTF-8 encoded character string representing the account name.

pathLength

The length of the path character string.

path

A UTF-8 encoded character string representing the path.

port

The TCP/IP port number. Pass 0 to ignore the port number.

protocol

The protocol associated with this password. See SecProtocolType for a description of possible values.

authenticationType

The authentication scheme used. See SecAuthenticationType for a description of possible values. Pass the constant kSecAuthenticationTypeDefault, to specify the default authentication scheme.

passwordLength

On return, the length of the buffer pointed to by passwordData.

passwordData

On return, a pointer to a buffer containing the password data. Pass NULL if you want to obtain the item object but not the password data. In this case, you must also pass NULL in the passwordLength parameter. You should use the SecKeychainItemFreeContent function to free the memory pointed to by this parameter.

itemRef

On return, a pointer to the item object of the Internet password. You are responsible for releasing your reference to this object. Pass NULL if you don’t want to obtain this object.

Return Value

Discussion

This function finds the first Internet password item that matches the attributes you provide. This function optionally returns a reference to the found item.

This function decrypts the password before returning it to you. If the calling application is not in the list of trusted applications, the user is prompted before access is allowed. If the access controls for this item do not allow decryption, the function returns the errSecAuthFailed result code.

This function automatically calls the function SecKeychainUnlock to display the Unlock Keychain dialog box if the keychain is currently locked.

See Also

Legacy Password Storage

SecKeychainAddInternetPassword

Adds a new Internet password to a keychain.

SecKeychainAddGenericPassword

Adds a new generic password to a keychain.

SecKeychainFindGenericPassword

Finds the first generic password based on the attributes passed.

SecProtocolType

The protocol type associated with an Internet password.

SecAuthenticationType

The authentication type to use for an Internet password.

SecPasswordRef

Contains information about a password.