OSX/libsecurity_keychain/lib/Password.h

   1 /*
   2  * Copyright (c) 2002-2004,2011,2014 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 //
  25 // Password.h - Password acquiring wrapper
  26 //
  27 #ifndef _SECURITY_PASSWORD_H_
  28 #define _SECURITY_PASSWORD_H_
  29
  30 #include <security_keychain/Item.h>
  31 // included by item #include <security_keychain/Keychains.h>
  32 #include <security_keychain/Access.h>
  33
  34
  35 namespace Security {
  36 namespace KeychainCore {
  37
  38 class PasswordImpl : public SecCFObject {
  39 public:
  40     SECCFFUNCTIONS(PasswordImpl, SecPasswordRef, errSecInvalidPasswordRef, gTypes().PasswordImpl)
  41
  42 public:
  43     // make default forms
  44     PasswordImpl(SecItemClass itemClass, SecKeychainAttributeList *searchAttrList, SecKeychainAttributeList *itemAttrList);
  45         PasswordImpl(PasswordImpl& existing);
  46
  47     virtual ~PasswordImpl() _NOEXCEPT;
  48
  49     bool getData(UInt32 *length, const void **data);
  50     void setData(UInt32 length,const void *data);
  51     void save();
  52     bool useKeychain() const { return mUseKeychain; }
  53     bool rememberInKeychain() const { return mRememberInKeychain; }
  54     void setRememberInKeychain(bool remember) { mRememberInKeychain = remember; }
  55     void setAccess(Access *access);
  56
  57 private:
  58     // keychain item cached?
  59     Keychain mKeychain;
  60     Item mItem;
  61     bool mUseKeychain;
  62     bool mFoundInKeychain;
  63     bool mRememberInKeychain;
  64         Mutex mMutex;
  65 };
  66
  67 class Password : public SecPointer<PasswordImpl>
  68 {
  69 public:
  70     Password(SecItemClass itemClass, SecKeychainAttributeList *searchAttrList, SecKeychainAttributeList *itemAttrList);
  71     Password(PasswordImpl *impl);
  72         Password(PasswordImpl &impl);
  73 };
  74
  75
  76
  77
  78 } // end namespace KeychainCore
  79 } // end namespace Security
  80
  81 #endif // !_SECURITY_PASSWORD_H_