X-Git-Url: https://git.saurik.com/apple/security.git/blobdiff_plain/5c19dc3ae3bd8e40a9c028b0deddd50ff337692c..3f0f0d49a9b6c2c6d459239f5926d59314cdeacf:/OSX/Breadcrumb/SecBreadcrumb.h diff --git a/OSX/Breadcrumb/SecBreadcrumb.h b/OSX/Breadcrumb/SecBreadcrumb.h index ad02d1ff..e7cc4088 100644 --- a/OSX/Breadcrumb/SecBreadcrumb.h +++ b/OSX/Breadcrumb/SecBreadcrumb.h @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2014 - 2016 Apple Inc. All Rights Reserved. + * + * @APPLE_LICENSE_HEADER_START@ + * + * This file contains Original Code and/or Modifications of Original Code + * as defined in and that are subject to the Apple Public Source License + * Version 2.0 (the 'License'). You may not use this file except in + * compliance with the License. Please obtain a copy of the License at + * http://www.opensource.apple.com/apsl/ and read it before using this + * file. + * + * The Original Code and all software distributed under the License are + * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER + * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, + * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. + * Please see the License for the specific language governing rights and + * limitations under the License. + * + * @APPLE_LICENSE_HEADER_END@ + */ + /*! @function SecBreadcrumbCreateFromPassword @abstract Encryptes the password using a random key and then returns @@ -6,7 +29,7 @@ @param inPassword is the password to encrypt and use to encrypt the random key. @param outBreadcrumb is the password encrypted using a random key. @param outEncryptedKey is the random key encrypted using inPassword. - @param error An optional pointer to a CFErrorRef. This value is set + @param outError An optional pointer to a CFErrorRef. This value is set if an error occurred. If not NULL, the caller is responsible for releasing the CFErrorRef. @result On return a Boolean indicating success or failure. @@ -31,10 +54,10 @@ SecBreadcrumbCreateFromPassword(CFStringRef inPassword, @param inPassword is the password to decrypt the encrypted random key. @param inBreadcrumb is the breadcrumb encrypted by the key. It contains and encrypted version of the users old password. - @param inEcryptedKey is an encrypted version of the key used to encrypt the + @param inEncryptedKey is an encrypted version of the key used to encrypt the breadcrumb. @param outPassword is the cleartext password that was stored in the breadcrumb. - @param error An optional pointer to a CFErrorRef. This value is set + @param outError An optional pointer to a CFErrorRef. This value is set if an error occurred. If not NULL, the caller is responsible for releasing the CFErrorRef. @result On return a Boolean indicating success or failure.